specifies service of a reference field. More...

import"GetReference.idl";

Inheritance diagram for GetReference:

Included Services
service	com::sun::star::text::TextField

Included Services inherited from TextField
service	com::sun::star::text::TextContent

Public Attributes
string	CurrentPresentation
	contains the current content of the text field. More...

short	ReferenceFieldSource
	contains the source of the reference. More...

string	SourceName
	contains the name of the source. More...

short	ReferenceFieldPart
	contains the type of the reference. More...

short	SequenceNumber
	contains the sequence number of a set expression field that is used as sequence field or the value of the ReferenceId property of a footnote or endnote. More...

string	ReferenceFieldLanguage
	contains the language id of the alternative language-dependent references. More...

short	ReferenceFieldFlags
	contains extra flags which can modify the behaviour of the field 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...

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
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 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

specifies service of a reference field.

See also: com::sun::star::text::TextField

Exported Interfaces

◆ com::sun::star::text::TextField

service com::sun::star::text::TextField

Member Data Documentation

◆ CurrentPresentation

string CurrentPresentation

property

contains the current content of the text field.

This property is especially useful for import/export purposes.

◆ ReferenceFieldFlags

short ReferenceFieldFlags

optionalproperty

contains extra flags which can modify the behaviour of the field

Since: LibreOffice 24.2

◆ ReferenceFieldLanguage

string ReferenceFieldLanguage

optionalproperty

contains the language id of the alternative language-dependent references.

Alternative language-dependent forms of reference types.

Since: LibreOffice 6.1

The current set of supported languages is:

hu : Hungarian, reference with lowercase article "a" or "az"
Hu : Hungarian, reference with uppercase article "A" or "Az"

◆ ReferenceFieldPart

short ReferenceFieldPart

property

contains the type of the reference.

See also: com::sun::star::text::ReferenceFieldPart

◆ ReferenceFieldSource

short ReferenceFieldSource

property

contains the source of the reference.

See also: com::sun::star::text::ReferenceFieldSource

◆ SequenceNumber

short SequenceNumber

property

contains the sequence number of a set expression field that is used as sequence field or the value of the ReferenceId property of a footnote or endnote.

See also: com::sun::star::text::Footnote

◆ SourceName

string SourceName

property

contains the name of the source.

Depending on the property ReferenceFieldSource it may be the name of a bookmark, a reference mark.

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

com/sun/star/text/textfield/GetReference.idl

Included Services

Public Attributes

Additional Inherited Members

Detailed Description

Exported Interfaces

◆ com::sun::star::text::TextField

Member Data Documentation

◆ CurrentPresentation

◆ ReferenceFieldFlags

◆ ReferenceFieldLanguage

◆ ReferenceFieldPart

◆ ReferenceFieldSource

◆ SequenceNumber

◆ SourceName