LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
DocumentProperties Service Referencepublished

provides document-specific information such as the author, creation date, and user-defined fields. More...

import"DocumentProperties.idl";

Inheritance diagram for DocumentProperties:
XDocumentProperties

Public Member Functions

 create ()
 constructs default-initialized instance More...
 
- Public Member Functions inherited from XDocumentProperties
void resetUserData ([in] string Author)
 resets all attributes that could identify the user. More...
 
com::sun::star::beans::XPropertyContainer getUserDefinedProperties ()
 provides access to a container for user-defined properties. More...
 
void loadFromStorage ([in] com::sun::star::embed::XStorage Storage, [in] sequence< com::sun::star::beans::PropertyValue > Medium) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::io::WrongFormatException, com::sun::star::lang::WrappedTargetException, com::sun::star::io::IOException )
 loads document properties from an ODF package. More...
 
void loadFromMedium ([in] string URL, [in] sequence< com::sun::star::beans::PropertyValue > Medium) raises ( com::sun::star::io::WrongFormatException, com::sun::star::lang::WrappedTargetException, com::sun::star::io::IOException )
 loads document properties from an ODF package or an OLE container. More...
 
void storeToStorage ([in] com::sun::star::embed::XStorage Storage, [in] sequence< com::sun::star::beans::PropertyValue > Medium) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException, com::sun::star::io::IOException )
 stores document properties to an ODF package. More...
 
void storeToMedium ([in] string URL, [in] sequence< com::sun::star::beans::PropertyValue > Medium) raises ( com::sun::star::lang::WrappedTargetException, com::sun::star::io::IOException )
 stores document properties to an ODF package or an OLE container. More...
 

Additional Inherited Members

- Public Attributes inherited from XDocumentProperties
string Author
 contains the initial author of the document. More...
 
string Generator
 identifies which application was used to create or last modify the document. More...
 
com::sun::star::util::DateTime CreationDate
 contains the date and time when the document was created. More...
 
string Title
 contains the title of the document. More...
 
string Subject
 contains the subject of the document. More...
 
string Description
 contains a multi-line comment describing the document. More...
 
sequence< string > Keywords
 contains a list of keywords for the document. More...
 
com::sun::star::lang::Locale Language
 contains the default language of the document. More...
 
string ModifiedBy
 contains the name of the person who most recently stored the document. More...
 
com::sun::star::util::DateTime ModificationDate
 contains the date and time of the last time the document was stored. More...
 
string PrintedBy
 contains the name of the person who most recently printed the document. More...
 
com::sun::star::util::DateTime PrintDate
 contains the date and time when the document was last printed. More...
 
string TemplateName
 contains the name of the template from which the document was created. More...
 
string TemplateURL
 contains the URL of the template from which the document was created. More...
 
com::sun::star::util::DateTime TemplateDate
 contains the date and time of when the document was created or updated from the template. More...
 
string AutoloadURL
 contains the URL to load automatically at a specified time after the document is loaded into a desktop frame. More...
 
long AutoloadSecs { set raises(com::sun::star::lang::IllegalArgumentException); }
 contains the number of seconds after which a specified URL is to be loaded after the document is loaded into a desktop frame. More...
 
string DefaultTarget
 contains the name of the default frame into which links should be loaded if no target is specified. More...
 
sequence< com::sun::star::beans::NamedValueDocumentStatistics
 contains some statistics about the document. More...
 
short EditingCycles { set raises(com::sun::star::lang::IllegalArgumentException); }
 describes how often the document was edited and saved. More...
 
long EditingDuration { set raises(com::sun::star::lang::IllegalArgumentException); }
 contains the net time of editing the document (in seconds). More...
 

Detailed Description

provides document-specific information such as the author, creation date, and user-defined fields.

This service replaces the deprecated DocumentInfo and StandaloneDocumentInfo services.

Since
OOo 3.0
See also
XDocumentProperties
XDocumentPropertiesSupplier

Member Function Documentation

create ( )

constructs default-initialized instance


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