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

unpublished interface XDocumentProperties
Description
This interface manages access to document properties that either have been set from the outside (e.g. when importing arbitrary document formats that support document properties) or have been imported from an ODF package.

Methods' Summary
getCustomProperties returns a container for custom properties  
loadFromStorage loads document properties from an ODF package  
loadFromMedium loads document properties from an ODF package or an OLE container  
storeToStorage stores document properties to an ODF package  
storeToMedium stores document properties to an ODF package or an OLE container  
Methods' Details
getCustomProperties
::com::sun::star::beans::XPropertyContainer
getCustomProperties();

Description
returns a container for custom properties

loadFromStorage
void
loadFromStorage( [in] ::com::sun::star::embed::XStorage  Storage )
raises( ::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );

Description
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.

Parameter Storage
the ::com.sun.star.embed.Storage representing the ODF package
loadFromMedium
void
loadFromMedium( [in] string  URL,
[in] sequence< ::com::sun::star::beans::PropertyValue >  Medium )
raises( ::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );

Description
loads document properties from an ODF package or an OLE container

For compatibility reasons this method also supports the import from former StarOffice binary file formats.

Parameter URL
the URL of the source document

The URL could be part of the Medium parameter also but because often no other parameters exept the URL are needed providing it separately was added for convenience reasons.

Parameter Medium
the ::com.sun.star.document.MediaDescriptor representing the source
storeToStorage
void
storeToStorage( [in] ::com::sun::star::embed::XStorage  Storage )
raises( ::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );

Description
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.

Parameter Storage
the ::com.sun.star.embed.Storage representing the ODF package
storeToMedium
void
storeToMedium( [in] string  URL,
[in] sequence< ::com::sun::star::beans::PropertyValue >  Medium )
raises( ::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );

Description
stores document properties to an ODF package or an OLE container

For compatibility reasons this method also supports the export to former StarOffice binary file formats.

Parameter URL
the URL of the target document

The URL could be part of the Medium parameter also but because often no other parameters exept the URL are needed providing it separately was added for convenience reasons.

Parameter Medium
the ::com.sun.star.document.MediaDescriptor representing the target
Attributes' Summary
Author contains the initial author of the document  
Generator identifies which application was used to create or last modify the document  
CreationDate contains the date and time of the first time the document was stored  
Title contains the title of the document  
Subject contains the subject of document  
Description contains a multi-line comment of the document  
Keywords contains a comma separated list of keywords for the document  
MIMEType contains the MIME-type of the document's resource  
Language default language of the document  
ModifiedBy contains the name of the editor who was the last person to store this document  
ModifyDate contains the date and time of the last time the document was stored  
PrintedBy contains the name of the editor who was the last person to print the document  
PrintDate contains the date and time of when the document was last printed  
Template contains the path and name of the template from which the document was created  
TemplateDate contains the date and time of when the document was created or updated from the template  
AutoloadURL contains the URL to load automatically after a specified time after the document is loaded into a desktop frame  
AutoloadSecs contains the number of seconds after which a specified URL is to be loaded after the document is loaded into a desktop frame  
DefaultTarget contains the name of the default frame into which links should be loaded if no target is specified  
Attributes' Details
Author
string Author;
Description
contains the initial author of the document
Generator
string Generator;
Description
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.

CreationDate
::com::sun::star::util::DateTime CreationDate;
Description
contains the date and time of the first time the document was stored
Title
string Title;
Description
contains the title of the document
Subject
string Subject;
Description
contains the subject of document
Description
string Description;
Description
contains a multi-line comment of the document

Line delimiters can be UNIX, Macintosh or DOS style.

Keywords
string Keywords;
Description
contains a comma separated list of keywords for the document
MIMEType
[ readonly ] string MIMEType;
Description
contains the MIME-type of the document's resource

The MIME-type is neither stored in the document information nor in the document; it is sent within a protocol header or is detected, thus it cannot be changed.

Language
::com::sun::star::lang::Locale Language;
Description
default language of the document
ModifiedBy
string ModifiedBy;
Description
contains the name of the editor who was the last person to store this document
ModifyDate
::com::sun::star::util::DateTime ModifyDate;
Description
contains the date and time of the last time the document was stored
PrintedBy
string PrintedBy;
Description
contains the name of the editor who was the last person to print the document
PrintDate
::com::sun::star::util::DateTime PrintDate;
Description
contains the date and time of when the document was last printed
Template
string Template;
Description
contains the path and 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.

TemplateDate
::com::sun::star::util::DateTime TemplateDate;
Description
contains the date and time of when the document was created or updated from the template
AutoloadURL
string AutoloadURL;
Description
contains the URL to load automatically after 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 loction 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.

AutoloadSecs
long AutoloadSecs;
Description
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. An empty string together with an AutoLoadSecs value of 0 describes a case where no AutoLoad is specified.

DefaultTarget
string DefaultTarget;
Description
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.

Top of Page