LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Exported Interfaces | Public Attributes | List of all members
MetadataField Service Reference

is a com::sun::star::text::TextField whose content is specified by RDF metadata. More...

import"MetadataField.idl";

Inheritance diagram for MetadataField:
TextField XMetadatable XText XEnumerationAccess XChild TextContent XTextField XPropertySet XURI XSimpleText XElementAccess XInterface XTextContent XTextContent XInterface XResource XTextRange XInterface XComponent XComponent XNode XInterface XInterface XInterface

Included Services

service com::sun::star::text::TextField
 None of the properties of com::sun::star::text::TextContent are supported. More...
 
- Included Services inherited from TextField
service com::sun::star::text::TextContent
 

Exported Interfaces

interface com::sun::star::rdf::XMetadatable
 The MetadataField can have RDF metadata attached. More...
 
interface com::sun::star::text::XText
 Allows for insertion of text content into, and creating cursors that are bound within, the MetadataField. More...
 
interface com::sun::star::container::XEnumerationAccess
 The com::sun::star::text::TextContents that are contained in the MetadataField can be enumerated. More...
 
interface com::sun::star::container::XChild
 The com::sun::star::text::TextContent that is the parent of this MetadataField. More...
 
- Exported Interfaces inherited from TextField
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

long NumberFormat
 this is the number format for this field. More...
 
boolean IsFixedLanguage
 determines whether changes in language attributes at the position of the text field also change the number format as appropriate for this language. More...
 
- Public Attributes inherited from TextField
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...
 
- 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::TextContentAnchorTypeAnchorTypes
 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...
 
- Public Attributes inherited from XMetadatable
com::sun::star::beans::StringPair MetadataReference { set raises(com::sun::star::lang::IllegalArgumentException); }
 a metadata reference, comprising the stream name and the XML ID. More...
 
- Public Attributes inherited from XURI
string Namespace
 prefix More...
 
string LocalName
 suffix More...
 
- Public Attributes inherited from XNode
string StringValue
 the string value of the node. 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)
 
- Public Member Functions inherited from XMetadatable
void ensureMetadataReference ()
 creates a metadata reference for this object, if necessary. More...
 
- Public Member Functions inherited from XText
void insertTextContent ([in] com::sun::star::text::XTextRange xRange, [in] com::sun::star::text::XTextContent xContent, [in] boolean bAbsorb) raises ( com::sun::star::lang::IllegalArgumentException )
 inserts a content, such as a text table, text frame or text field. More...
 
void removeTextContent ([in] com::sun::star::text::XTextContent xContent) raises ( com::sun::star::container::NoSuchElementException )
 removes the specified content from the text object. More...
 
- Public Member Functions inherited from XSimpleText
com::sun::star::text::XTextCursor createTextCursor ()
 
com::sun::star::text::XTextCursor createTextCursorByRange ([in] com::sun::star::text::XTextRange aTextPosition)
 
void insertString ([in] com::sun::star::text::XTextRange xRange, [in] string aString, [in] boolean bAbsorb)
 inserts a string of characters into the text. More...
 
void insertControlCharacter ([in] com::sun::star::text::XTextRange xRange, [in] short nControlCharacter, [in] boolean bAbsorb) raises ( com::sun::star::lang::IllegalArgumentException )
 inserts a control character (like a paragraph break or a hard space) into the text. More...
 
- Public Member Functions inherited from XTextRange
XText getText ()
 
XTextRange getStart ()
 
XTextRange getEnd ()
 
string getString ()
 
void setString ([in] string aString)
 the whole string of characters of this piece of text is replaced. More...
 
- Public Member Functions inherited from XEnumerationAccess
com::sun::star::container::XEnumeration createEnumeration ()
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- Public Member Functions inherited from XChild
com::sun::star::uno::XInterface getParent ()
 grants access to the object containing this content. More...
 
void setParent ([in] com::sun::star::uno::XInterface Parent) raises ( com::sun::star::lang::NoSupportException )
 sets the parent to this object. More...
 
- 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

is a com::sun::star::text::TextField whose content is specified by RDF metadata.

Since
OOo 3.2
See also
com::sun::star::rdf

Exported Interfaces

None of the properties of com::sun::star::text::TextContent are supported.

Exported Interfaces

The com::sun::star::text::TextContent that is the parent of this MetadataField.

Since
OOo 3.3

The com::sun::star::text::TextContents that are contained in the MetadataField can be enumerated.

The MetadataField can have RDF metadata attached.

Allows for insertion of text content into, and creating cursors that are bound within, the MetadataField.

Member Data Documentation

boolean IsFixedLanguage
optionalproperty

determines whether changes in language attributes at the position of the text field also change the number format as appropriate for this language.

long NumberFormat
optionalproperty

this is the number format for this field.

See also
com::sun::star::util::NumberFormatter

The documentation for this service was generated from the following file: