interface XDocumentInfo in module com::sun::star::document::

(Global Index)

Syntax

interface XDocumentInfo : com::sun::star::uno::XInterface ;

Description

provides access to the user fields for the information regarding the document.

Other fields are accessed as properties (interface XPropertySet and interface XFastPropertySet).

See also

DocumentInfo

See also

XStandaloneDocumentInfo

See also

XPropertySet

See also

XFastPropertySet

Method Summary

getUserFieldCount

getUserFieldName

getUserFieldValue

setUserFieldName changes the name of one of the user fields.

setUserFieldValue changes the value of the nIndex th user field.

Known Services Which Export this Interface

com::sun::star::document::DocumentInfo

Method Details



getUserFieldCount

Syntax

short getUserFieldCount ();

Returns

the number of user fields available in the document information.

getUserFieldName

Syntax

string getUserFieldName (
short nIndex )
raises ( com::sun::star::lang::ArrayIndexOutOfBoundsException );

Returns

the name of the user field at the specified position.

getUserFieldValue

Syntax

string getUserFieldValue (
short nIndex )
raises ( com::sun::star::lang::ArrayIndexOutOfBoundsException );

Returns

the value of the user field at the specified position.

setUserFieldName

Syntax

void setUserFieldName (
short nIndex,
string aName )
raises ( com::sun::star::lang::ArrayIndexOutOfBoundsException );

Description

changes the name of one of the user fields.


setUserFieldValue

Syntax

void setUserFieldValue (
short nIndex,
string aValue )
raises ( com::sun::star::lang::ArrayIndexOutOfBoundsException );

Description

changes the value of the nIndex th user field.

Top of Page