Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

deprecated service DocumentInfo
Usage Restrictions
deprecated
Deprecation Info
Use DocumentProperties instead.
Description
this service provides document-specific information like the author, creation date and user fields

Contrary to the service StandaloneDocumentInfo the document - which contains such informations - must be loaded completly. As a result of that this DocumengInfo service is available on an open document via the interface XDocumentInfoSupplier only.

See also
StandaloneDocumentInfo, XDocumentInfoSupplier

Exported Interfaces - Summary
XDocumentInfo

provides access to the user fields for the information regarding the document (details)

::com::sun::star::beans::XPropertySet

neccessary to support normal properties

::com::sun::star::beans::XFastPropertySet

supports faster access on well known properties by using index

::com::sun::star::beans::XPropertyContainer

provides access to the user fields, which (instead to the user fields set by the interface XDocumentInfo) will be typesafe. (details)

Properties' Summary
string
Author
contains the intial author of the document  
boolean
AutoloadEnabled
[ DEPRECATED ]
 
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
AutoloadURL
contains the URL to load automatically after a specified time after the document is loaded into a desktop frame  
::com::sun::star::util::DateTime
CreationDate
contains the date and time of the first time the document was stored  
string
DefaultTarget
contains the name of the default frame into which links should be loaded if no target is specified  
string
Description
contains a multi-line comment of the document  
sequence< ::com::sun::star::beans::NamedValue >
DocumentStatistic
contains some statistics about the document  
short
EditingCycles
describes how often the document was edited and saved  
long
EditingDuration
contains the net time of editing the document (in seconds)  
string
Generator
identifies application was used to create or last modify the document  
string
Keywords
contains a comma separated list of keywords for the document  
[ readonly ] string
MIMEType
contains the MIME-type of the document's resource  
::com::sun::star::lang::Locale
Language
default language of the document  
string
ModifiedBy
contains the name of the editor who was the last person to store this document  
::com::sun::star::util::DateTime
ModifyDate
contains the date and time of the last time the document was stored  
::com::sun::star::util::DateTime
PrintDate
contains the date and time of when the document was last printed  
string
PrintedBy
contains the name of the editor who was the last person to print the document  
string
Subject
subject of document  
string
Template
contains logical name of the template from which the document was created  
string
TemplateFileName
contains the file path name 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
Title
contains the title of the document  
Exported Interfaces - Details
XDocumentInfo
Description
provides access to the user fields for the information regarding the document

These fields are additional to normal properties. (see below)

::com::sun::star::beans::XPropertySet
Description
neccessary to support normal properties
::com::sun::star::beans::XFastPropertySet
Description
supports faster access on well known properties by using index
::com::sun::star::beans::XPropertyContainer
Usage Restrictions
optional
Description
provides access to the user fields, which (instead to the user fields set by the interface XDocumentInfo) will be typesafe.

These fields are additional to normal properties (see below) and additional to the user fields set by the interface XDocumentInfo (see before).

Properties' Details
Author
string Author;
Description
contains the intial author of the document
AutoloadEnabled
boolean AutoloadEnabled;
Usage Restrictions
deprecated
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
AutoloadURL
string AutoloadURL;
Description
contains the URL to load automatically after a specified time after the document is loaded into a desktop frame
CreationDate
::com::sun::star::util::DateTime CreationDate;
Description
contains the date and time of the first time the document was stored
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.

Description
string Description;
Description
contains a multi-line comment of the document

Line delimiters can be UNIX, Macintosh or DOS style.

DocumentStatistic
sequence< ::com::sun::star::beans::NamedValue > DocumentStatistic;
Description
contains some statistics about the document

The exact name and type of the values depends on the document type

EditingCycles
short EditingCycles;
Description
describes how often the document was edited and saved
EditingDuration
long EditingDuration;
Description
contains the net time of editing the document (in seconds)
Generator
string Generator;
Description
identifies application was used to create or last modify the document
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
PrintDate
::com::sun::star::util::DateTime PrintDate;
Description
contains the date and time of when the document was last printed
PrintedBy
string PrintedBy;
Description
contains the name of the editor who was the last person to print the document
Subject
string Subject;
Description
subject of document
Template
string Template;
Description
contains logical 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.

TemplateFileName
string TemplateFileName;
Description
contains the file path name of the template from which the document was created
TemplateDate
::com::sun::star::util::DateTime TemplateDate;
Description
contains the date and time of when the document was created or updated from the template
Title
string Title;
Description
contains the title of the document

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.