Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.3 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: text ::

service TextField
Description
A TextField is a TextContent which fades its textual representation into the text range to which it is anchored.
Developers Guide
Text - Text Fields

Included Services - Summary
TextContent
(referenced entity's summary:)
is an object which can be anchored in a text, like instances of TextFrame or TextField.
Exported Interfaces - Summary
XTextField

This interface is used to access the textual representation of this field.

::com::sun::star::beans::XPropertySet

makes it possible to access the properties of the field, if any. (details)

Properties' Summary
[ readonly ] boolean
IsFieldUsed
[ OPTIONAL ]
specifies if the text field is actually used in the document.  
[ readonly ] boolean
IsFieldDisplayed
[ OPTIONAL ]
specifies if the text field is actually displayed.  
Included Services - Details
TextContent
(referenced entity's summary:)
is an object which can be anchored in a text, like instances of TextFrame or TextField.
Exported Interfaces - Details
XTextField
Description
This interface is used to access the textual representation of this field.
::com::sun::star::beans::XPropertySet
Usage Restrictions
optional
Description
makes it possible to access the properties of the field, if any.
Properties' Details
IsFieldUsed
[ readonly ] boolean IsFieldUsed;
Usage Restrictions
optional
Description
specifies if the text field is actually used in the document.

Not all available text fields are used, for example fields that are part of unused styles.

Since
OOo 2.0.1
IsFieldDisplayed
[ readonly ] boolean IsFieldDisplayed;
Usage Restrictions
optional
Description
specifies if the text field is actually displayed.

Not all available text fields are actually displayed even when they are used. For example hidden fields or fields in hidden text are used in the document but get not displayed.

Since
OOo 2.0.1

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.