A TextField is a TextContent which fades its textual representation into the text range to which it is anchored. More...
import"TextField.idl";
Inheritance diagram for TextField:
Included Services | |
| service | com::sun::star::text::TextContent |
Exported Interfaces | |
| interface | com::sun::star::text::XTextField |
| This interface is used to access the textual representation of this field. More... | |
| interface | com::sun::star::beans::XPropertySet |
| makes it possible to access the properties of the field, if any. More... | |
 Exported Interfaces inherited from TextContent | |
| interface | com::sun::star::text::XTextContent |
| This interface is used for the attachment of this text content to the surrounding text. More... | |
Public Attributes | |
| boolean | IsFieldUsed |
| specifies if the text field is actually used in the document. More... | |
| boolean | IsFieldDisplayed |
| specifies if the text field is actually displayed. More... | |
| string | Title |
| Contains short title for the field, used to for tooltip purposes if it's non-empty. More... | |
| Public Attributes inherited from TextContent | |
| com::sun::star::text::TextContentAnchorType | AnchorType |
| specifies how the text content is attached to its surrounding Text. More... | |
| sequence< com::sun::star::text::TextContentAnchorType > | AnchorTypes |
| contains the anchor type of the text content. More... | |
| com::sun::star::text::WrapTextMode | TextWrap |
| specifies if the text content is a shape and how the text is wrapped around the shape. More... | |
Additional Inherited Members | |
| Public Member Functions inherited from XTextContent | |
| void | attach ([in] com::sun::star::text::XTextRange xTextRange) raises ( com::sun::star::lang::IllegalArgumentException ) |
| is called when this object gets embedded in a text. More... | |
| com::sun::star::text::XTextRange | getAnchor () |
| Public Member Functions inherited from XComponent | |
| void | dispose () |
| The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More... | |
| void | addEventListener ([in] XEventListener xListener) |
| adds an event listener to the object. More... | |
| void | removeEventListener ([in] XEventListener aListener) |
| removes an event listener from the listener list. More... | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More... | |
| void | acquire () |
| increases the reference counter by one. More... | |
| void | release () |
| decreases the reference counter by one. More... | |
| Public Member Functions inherited from XTextField | |
| string | getPresentation ([in] boolean bShowCommand) |
| Protected Member Functions inherited from XPropertySet | |
| com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
| void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
| sets the value of the property with the specified name. More... | |
| any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XPropertyChangeListener to the specified property. More... | |
| void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XPropertyChangeListener from the listener list. More... | |
| void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XVetoableChangeListener to the specified property with the name PropertyName. More... | |
| void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XVetoableChangeListener from the listener list. More... | |
Detailed Description
A TextField is a TextContent which fades its textual representation into the text range to which it is anchored.
- Developers Guide
- Text Documents - Text Fields
Exported Interfaces
◆ com::sun::star::text::TextContent
Exported Interfaces
◆ com::sun::star::beans::XPropertySet
|
optional |
makes it possible to access the properties of the field, if any.
◆ com::sun::star::text::XTextField
| interface com::sun::star::text::XTextField |
This interface is used to access the textual representation of this field.
Member Data Documentation
◆ IsFieldDisplayed
|
optionalpropertyreadonly |
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
◆ IsFieldUsed
|
optionalpropertyreadonly |
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
◆ Title
|
optionalproperty |
Contains short title for the field, used to for tooltip purposes if it's non-empty.
- Since
- LibreOffice 7.4
The documentation for this service was generated from the following file:
- com/sun/star/text/TextField.idl
