Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

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

interface XDocumentInfo

Base Interface
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
com::sun::star::beans::XPropertySet
See also
com::sun::star::beans::XFastPropertySet


Known Services which Export this Interface

com::sun::star::document::DocumentInfo This service provides document-specific information like the author, creation date and user fields.

Methods' Summary

getUserFieldCount
getUserFieldName
getUserFieldValue
setUserFieldName changes the name of one of the user fields.
setUserFieldValue changes the value of the nIndex th user field.

Methods' Details

getUserFieldCount
 
short
getUserFieldCount();
Returns
the number of user fields available in the document information.
getUserFieldName
 
string
getUserFieldName(
[ in ] short nIndex )
raises ( com::sun::star::lang::ArrayIndexOutOfBoundsException );

Returns
the name of the user field at the specified position.
getUserFieldValue
 
string
getUserFieldValue(
[ in ] short nIndex )
raises ( com::sun::star::lang::ArrayIndexOutOfBoundsException );

Returns
the value of the user field at the specified position.
setUserFieldName
 
void
setUserFieldName(
[ in ] short nIndex,
[ in ] string aName )
raises ( com::sun::star::lang::ArrayIndexOutOfBoundsException );

Description
changes the name of one of the user fields.
setUserFieldValue
 
void
setUserFieldValue(
[ in ] short nIndex,
[ in ] string aValue )
raises ( com::sun::star::lang::ArrayIndexOutOfBoundsException );

Description
changes the value of the nIndex th user field.

Top of Page