LibreOffice
LibreOffice 24.8 SDK API Reference
|
provides document-specific information such as the author, creation date, and user-defined fields. More...
import <XDocumentProperties.idl;
Public Types | |
typedef sequence< string > | Keywords |
contains a list of keywords for the document. | |
typedef sequence< com::sun::star::beans::NamedValue > | DocumentStatistics |
contains some statistics about the document. | |
Public Attributes | |
string | Author |
contains the initial author of the document. | |
string | Generator |
identifies which application was used to create or last modify the document. | |
com::sun::star::util::DateTime | CreationDate |
contains the date and time when the document was created. | |
string | Title |
contains the title of the document. | |
string | Subject |
contains the subject of the document. | |
string | Description |
contains a multi-line comment describing the document. | |
com::sun::star::lang::Locale | Language |
contains the default language of the document. | |
string | ModifiedBy |
contains the name of the person who most recently stored the document. | |
com::sun::star::util::DateTime | ModificationDate |
contains the date and time of the last time the document was stored. | |
string | PrintedBy |
contains the name of the person who most recently printed the document. | |
com::sun::star::util::DateTime | PrintDate |
contains the date and time when the document was last printed. | |
string | TemplateName |
contains the name of the template from which the document was created. | |
string | TemplateURL |
contains the URL of the template from which the document was created. | |
com::sun::star::util::DateTime | TemplateDate |
contains the date and time of when the document was created or updated from the template. | |
string | AutoloadURL |
contains the URL to load automatically at a specified time after the document is loaded into a desktop frame. | |
long | AutoloadSecs |
contains the number of seconds after which a specified URL is to be loaded after the document is loaded into a desktop frame. | |
string | DefaultTarget |
contains the name of the default frame into which links should be loaded if no target is specified. | |
short | EditingCycles |
describes how often the document was edited and saved. | |
long | EditingDuration |
contains the net time of editing the document (in seconds). | |
provides document-specific information such as the author, creation date, and user-defined fields.
This interface manages access to document meta-data properties. Such properties may be set from the outside via the setter methods (e.g. when importing arbitrary document formats that support document properties), or imported from an ODF package via the methods loadFromStorage() and loadFromMedium(). The properties may also be stored via the methods storeToStorage() and storeToMedium().
|
attribute |
contains some statistics about the document.
The contained statistics may be specific to the type of the document.
|
attribute |
contains a list of keywords for the document.
com::sun::star::beans::XPropertyContainer getUserDefinedProperties | ( | ) |
provides access to a container for user-defined properties.
The returned object also implements the interface com::sun::star::beans::XPropertySet.
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.
URL | the URL of the source document |
The URL could be part of the Medium parameter, but because often no other parameters except the URL are needed, providing it separately was added for convenience.
Medium | the com::sun::star::document::MediaDescriptor representing the source |
com::sun::star::io::WrongFormatException | if parsing the XML document fails |
com::sun::star::lang::WrappedTargetException | if thrown when trying to open a stream in the given storage |
com::sun::star::io::IOException | if thrown when trying to open a stream in the given storage |
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.
This method is used for accessing an ODF package that is owned by someone else, e.g., a document.
Storage | the com::sun::star::embed::Storage representing the ODF package |
Medium | the com::sun::star::document::MediaDescriptor representing the source |
This is unfortunately necessary in order to properly resolve relative URLs in the meta-data.
com::sun::star::lang::IllegalArgumentException | if argument is NULL |
com::sun::star::io::WrongFormatException | if parsing the XML document fails |
com::sun::star::lang::WrappedTargetException | if thrown when trying to open a stream in the given storage |
com::sun::star::io::IOException | if thrown when trying to open a stream in the given storage |
void resetUserData | ( | [in] string | Author | ) |
resets all attributes that could identify the user.
Clears the document properties, such that it appears the document has just been created. This is a convenience method which resets several attributes at once, as follows:
Author | the new value of the Author attribute. |
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.
URL | the URL of the target document |
The URL could be part of the Medium parameter, but because often no other parameters except the URL are needed, providing it separately was added for convenience.
Medium | the com::sun::star::document::MediaDescriptor representing the target |
com::sun::star::lang::WrappedTargetException | if thrown when trying to open a stream in the given storage |
com::sun::star::io::IOException | if thrown when writing to the storage |
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.
This method is used for accessing an ODF package that is owned by someone else, e.g., a document. Note that the implementation may choose to store the meta-data in either OOo or ODF format, depending on the MediaType property of the given Storage argument.
Storage | the com::sun::star::embed::Storage representing the ODF package |
Medium | the com::sun::star::document::MediaDescriptor representing the source |
This is unfortunately necessary in order to properly resolve relative URLs in the meta-data.
com::sun::star::lang::IllegalArgumentException | if argument is NULL |
com::sun::star::lang::WrappedTargetException | if thrown when trying to open a stream in the given storage |
com::sun::star::io::IOException | if thrown when writing to the storage |
|
attribute |
contains the initial author of the document.
|
attribute |
contains the number of seconds after which a specified URL is to be loaded after the document is loaded into a desktop frame.
A value of 0 is valid and describes a redirection. A value of 0 together with an empty string
as AutoloadURL describes a case where no autoload is specified.
com::sun::star::lang::IllegalArgumentException | if argument is negative |
|
attribute |
contains the URL to load automatically at a specified time after the document is loaded into a desktop frame.
An empty URL is valid and describes a case where the document shall be reloaded from its original location after some time described by the attribute AutoloadSecs. An empty string
together with an AutoloadSecs value of 0 describes a case where no autoload is specified.
|
attribute |
contains the date and time when the document was created.
|
attribute |
contains the name of the default frame into which links should be loaded if no target is specified.
This applies to the autoload feature too, but to others as well.
|
attribute |
contains a multi-line comment describing the document.
Line delimiters can be UNIX, Macintosh or DOS style.
|
attribute |
describes how often the document was edited and saved.
com::sun::star::lang::IllegalArgumentException | if argument is negative |
|
attribute |
contains the net time of editing the document (in seconds).
com::sun::star::lang::IllegalArgumentException | if argument is negative |
|
attribute |
identifies which application was used to create or last modify the document.
The generating application will set this attribute when it creates a new document or it saves a document. When a document is loaded that itself contains such an attribute it will be preserved until the document is saved again.
|
attribute |
contains the default language of the document.
|
attribute |
contains the date and time of the last time the document was stored.
If the document has never been stored, contains a default value.
|
attribute |
contains the name of the person who most recently stored the document.
|
attribute |
contains the date and time when the document was last printed.
If the document has never been printed, contains a default value.
|
attribute |
contains the name of the person who most recently printed the document.
|
attribute |
contains the subject of the document.
|
attribute |
contains the date and time of when the document was created or updated from the template.
|
attribute |
contains the name of the template from which the document was created.
The value is an empty string
if the document was not created from a template or if it was detached from the template.
|
attribute |
contains the URL of the template from which the document was created.
The value is an empty string
if the document was not created from a template or if it was detached from the template.
|
attribute |
contains the title of the document.