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

interface XDocumentInfo
Base Hierarchy
::com::sun::star::uno::XInterface
 |
 +-XDocumentInfo
Description
provides access to the user fields for the information regarding the document

These fields are special one of the set of available document properties. Other ones are accessed as properties (by using the interface ::com::sun::star::beans::XPropertySet ) of service DocumentInfo .

See also
DocumentInfo
See also
StandaloneDocumentInfo
See also
::com::sun::star::beans::XPropertySet

Methods' Summary
getUserFieldCount provides information about count of available fields
getUserFieldName returns the name of an user field
getUserFieldValue returns the value of an user field
setUserFieldName changes the name of one of the user fields
setUserFieldValue changes the value of one of the user fields
Methods' Details
getUserFieldCount
short
getUserFieldCount();
 
 

Description
provides information about count of available fields

This count marks the top range of possible requests for get/set any of these fields. Range = [0..count-1]

Returns
current count
getUserFieldName
string
getUserFieldName(
 
[in] short 

raises(

 
Index ) 
::com::sun::star::lang::ArrayIndexOutOfBoundsException );

Description
returns the name of an user field
Parameter Index
specifies the position of requested field Range = [0..count-1]
Returns
the name of the requested field
Throws
com::sun::star::lang::ArrayIndexOutOfBoundsException if Index don't fit range of [0..count-1]
getUserFieldValue
string
getUserFieldValue(
 
[in] short 

raises(

 
Index ) 
::com::sun::star::lang::ArrayIndexOutOfBoundsException );

Description
returns the value of an user field
Parameter Index
specifies the position of requested field Range = [0..count-1]
Returns
the value of the requested field
Throws
com::sun::star::lang::ArrayIndexOutOfBoundsException if Index don't fit range of [0..count-1]
setUserFieldName
void
setUserFieldName(
 
[in] short
[in] string 

raises(

 
Index,
Name ) 
::com::sun::star::lang::ArrayIndexOutOfBoundsException );

Description
changes the name of one of the user fields
Parameter Index
specifies the position of requested field Range = [0..count-1]
Parameter Name
the new name for this field to be set
Throws
com::sun::star::lang::ArrayIndexOutOfBoundsException if Index don't fit range of [0..count-1]
setUserFieldValue
void
setUserFieldValue(
 
[in] short
[in] string 

raises(

 
Index,
Value ) 
::com::sun::star::lang::ArrayIndexOutOfBoundsException );

Description
changes the value of one of the user fields
Parameter Index
specifies the position of requested field Range = [0..count-1]
Parameter Value
the new value for this field to be set
Throws
com::sun::star::lang::ArrayIndexOutOfBoundsException if Index don't fit range of [0..count-1]
Top of Page