service DocumentInfo in module com::sun::star::document::

(Global Index)

Syntax

service DocumentInfo;

Description

This service provides document-specific information like the author, creation date and user fields.

See also

StandaloneDocumentInfo

Exported Interfaces

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

Description

provides access to the user fields for the information regarding the document.


com::sun::star::lang::XComponent

Description

allows to exclicitly free resources and break cyclic references.


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

Description

provides information about and access to the properties from an implementation.


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

Description

provides a fast way of accessing and changing property values.


Property Summary

Author contains the intial author of the document.

BlindCopiesTo contains the recipients who have received or will receive a blind copy by email.

CopyTo contains the recipients who have received or will receive a copy by email.

CreationDate contains the date and time of the first time the document was stored.

Description contains a multi-line comment of the document.

InReplyTo contains the message ID to which this is an answer.

Keywords contains a comma separated list of keywords for the document.

MIMEType contains the MIME-type of the document's resource.

ModifyDate contains the date and time of the last time the document was stored.

ModifiedBy contains the name of the editor who was the last person to store this document.

Newsgroups contains the list of newsgroups where this document was or will be posted.

Original contains the source of the document,

Priority contains the priority of the document.

Recipient contains the recipient of the document.

References contains a list of referred message IDs.

ReplyTo contains the mailto:-URL for where to send an answer.

Theme contains a theme describing the topic of the document.

Title contains the title of the document.

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.

IsEncrypted determines if the document is encrypted with a password.

PrintDate contains the date and time of when the document was last printed.

PrintedBy contains the name of the editor who was the last person to print the document.

AutoloadEnabled determines if another (or the same) URL is to be reloaded automatically after a specified time after the document is loaded into a desktop frame.

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.

Property Details



Author

Syntax

string Author;

Description

contains the intial author of the document.


BlindCopiesTo

Syntax

string BlindCopiesTo;

Description

contains the recipients who have received or will receive a blind copy by email.

Recipients who receive a blind copy are not visible to other recipients.

If there is more than one recipient, a comma is used as a delimiter.


CopyTo

Syntax

string CopyTo;

Description

contains the recipients who have received or will receive a copy by email.

These recipients are visible to other recipients.

If there is more than one recipient, a comma is used as a delimiter.


CreationDate

Syntax

com::sun::star::util::DateTime CreationDate;

Description

contains the date and time of the first time the document was stored.


Description

Syntax

string Description;

Description

contains a multi-line comment of the document.

Line delimiters can be UNIX, Macintosh or DOS style.


InReplyTo

Syntax

string InReplyTo;

Description

contains the message ID to which this is an answer.


Keywords

Syntax

string Keywords;

Description

contains a comma separated list of keywords for the document.


MIMEType

Syntax

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


ModifyDate

Syntax

com::sun::star::util::DateTime ModifyDate;

Description

contains the date and time of the last time the document was stored.


ModifiedBy

Syntax

string ModifiedBy;

Description

contains the name of the editor who was the last person to store this document.


Newsgroups

Syntax

string Newsgroups;

Description

contains the list of newsgroups where this document was or will be posted.

If there is more than one entry, the list is separated by a comma(s).


Original

Syntax

string Original;

Description

contains the source of the document,

i.e., the message ID for a locally stored message.


Priority

Syntax

short Priority;

Description

contains the priority of the document.

The value can be between 0 (very high) and 4 (very low).


Recipient

Syntax

string Recipient;

Description

contains the recipient of the document.


References

Syntax

string References;

Description

contains a list of referred message IDs.


ReplyTo

Syntax

string ReplyTo;

Description

contains the mailto:-URL for where to send an answer.


Theme

Syntax

string Theme;

Description

contains a theme describing the topic of the document.


Title

Syntax

string Title;

Description

contains the title of the document.


Template

Syntax

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

Syntax

com::sun::star::util::DateTime TemplateDate;

Description

contains the date and time of when the document was created or updated from the template.


IsEncrypted

Syntax

[readonly] boolean IsEncrypted;

Description

determines if the document is encrypted with a password.

It is not possible to set this value because the document which belongs to this DocumentInfo would no longer be loadable.

The password itself is not stored in the document.


PrintDate

Syntax

com::sun::star::util::DateTime PrintDate;

Description

contains the date and time of when the document was last printed.


PrintedBy

Syntax

string PrintedBy;

Description

contains the name of the editor who was the last person to print the document.


AutoloadEnabled

Syntax

boolean AutoloadEnabled;

Description

determines if another (or the same) URL is to be reloaded automatically after a specified time after the document is loaded into a desktop frame.


AutoloadURL

Syntax

string AutoloadURL;

Description

contains the URL to load automatically after a specified time after the document is loaded into a desktop frame.


AutoloadSecs

Syntax

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.


DefaultTarget

Syntax

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