<html> <head> <title>Service DocumentInfo</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="DocumentInfo-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub">Included Services</td> <td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">document</a> :: </p> </td> </tr> <tr> <td class="title">service DocumentInfo</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>this service provides document-specific information like the author, creation date and user fields </dd> <dd><p> Contrary to the service <a href="StandaloneDocumentInfo.html">StandaloneDocumentInfo</a> 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 <a href="XDocumentInfoSupplier.html">XDocumentInfoSupplier</a> only. </p> </dd> <dt><b>See also</b></dt> <dd><a href="StandaloneDocumentInfo.html">StandaloneDocumentInfo</a>, <a href="XDocumentInfoSupplier.html">XDocumentInfoSupplier</a></dd> </dl> </td> </tr> </table> <hr> <a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces</td> </tr> <tr> <td class="imsum_left"><a href="XDocumentInfo.html">XDocumentInfo</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>provides access to the user fields for the information regarding the document </dd> <dd><p> These fields are additional to normal properties. (see below) </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>neccessary to support normal properties </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XFastPropertySet.html">XFastPropertySet</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>supports faster access on well known properties by using index </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertyContainer.html">XPropertyContainer</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>provides access to the user fields, which (instead to the user fields set by the interface XDocumentInfo) will be typesafe. </dd> <dd><p> These fields are additional to normal properties (see below) and additional to the user fields set by the interface XDocumentInfo (see before). </p> </dd> </dl> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Author">Author</a></td> <td class="imsum_right">contains the intial author of the document </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#AutoloadEnabled">AutoloadEnabled</a></td> <td class="imsum_right"><b>[ DEPRECATED ]<br> </b> </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#AutoloadSecs">AutoloadSecs</a></td> <td class="imsum_right">contains the number of seconds after which a specified URL is to be loaded after the document is loaded into a desktop frame </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#AutoloadURL">AutoloadURL</a></td> <td class="imsum_right">contains the URL to load automatically after a specified time after the document is loaded into a desktop frame </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/DateTime.html">DateTime</a><br> <a href="#CreationDate">CreationDate</a></td> <td class="imsum_right">contains the date and time of the first time the document was stored </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#DefaultTarget">DefaultTarget</a></td> <td class="imsum_right">contains the name of the default frame into which links should be loaded if no target is specified </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Description">Description</a></td> <td class="imsum_right">contains a multi-line comment of the document </td> </tr> <tr> <td class="imsum_left">sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/NamedValue.html">NamedValue</a> ><br> <a href="#DocumentStatistic">DocumentStatistic</a></td> <td class="imsum_right">contains some statistics about the document </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#EditingCycles">EditingCycles</a></td> <td class="imsum_right">describes how often the document was edited and saved </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#EditingDuration">EditingDuration</a></td> <td class="imsum_right">contains the net time of editing the document (in seconds) </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Generator">Generator</a></td> <td class="imsum_right">identifies application was used to create or last modify the document </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Keywords">Keywords</a></td> <td class="imsum_right">contains a comma separated list of keywords for the document </td> </tr> <tr> <td class="imsum_left">[ readonly ] string<br> <a href="#MIMEType">MIMEType</a></td> <td class="imsum_right">contains the MIME-type of the document's resource </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a><br> <a href="#Language">Language</a></td> <td class="imsum_right">default language of the document </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ModifiedBy">ModifiedBy</a></td> <td class="imsum_right">contains the name of the editor who was the last person to store this document </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/DateTime.html">DateTime</a><br> <a href="#ModifyDate">ModifyDate</a></td> <td class="imsum_right">contains the date and time of the last time the document was stored </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/DateTime.html">DateTime</a><br> <a href="#PrintDate">PrintDate</a></td> <td class="imsum_right">contains the date and time of when the document was last printed </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#PrintedBy">PrintedBy</a></td> <td class="imsum_right">contains the name of the editor who was the last person to print the document </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Subject">Subject</a></td> <td class="imsum_right">subject of document </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Template">Template</a></td> <td class="imsum_right">contains logical name of the template from which the document was created </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#TemplateFileName">TemplateFileName</a></td> <td class="imsum_right">contains the file path name of the template from which the document was created </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/DateTime.html">DateTime</a><br> <a href="#TemplateDate">TemplateDate</a></td> <td class="imsum_right">contains the date and time of when the document was created or updated from the template </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Title">Title</a></td> <td class="imsum_right">contains the title of the document </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="Author" class="membertitle">Author</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Author</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the intial author of the document </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AutoloadEnabled" class="membertitle">AutoloadEnabled</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>AutoloadEnabled</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AutoloadSecs" class="membertitle">AutoloadSecs</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>AutoloadSecs</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the number of seconds after which a specified URL is to be loaded after the document is loaded into a desktop frame </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AutoloadURL" class="membertitle">AutoloadURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>AutoloadURL</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the URL to load automatically after a specified time after the document is loaded into a desktop frame </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CreationDate" class="membertitle">CreationDate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/DateTime.html">DateTime</a> <b>CreationDate</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the date and time of the first time the document was stored </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DefaultTarget" class="membertitle">DefaultTarget</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>DefaultTarget</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the name of the default frame into which links should be loaded if no target is specified </dd> <dd><p> This applies to the autoload feature too, but to others as well. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Description" class="membertitle">Description</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Description</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains a multi-line comment of the document </dd> <dd><p> Line delimiters can be UNIX, Macintosh or DOS style. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DocumentStatistic" class="membertitle">DocumentStatistic</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/NamedValue.html">NamedValue</a> > <b>DocumentStatistic</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains some statistics about the document </dd> <dd><p> The exact name and type of the values depends on the document type </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EditingCycles" class="membertitle">EditingCycles</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>EditingCycles</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>describes how often the document was edited and saved </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EditingDuration" class="membertitle">EditingDuration</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>EditingDuration</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the net time of editing the document (in seconds) </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Generator" class="membertitle">Generator</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Generator</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>identifies application was used to create or last modify the document </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Keywords" class="membertitle">Keywords</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Keywords</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains a comma separated list of keywords for the document </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MIMEType" class="membertitle">MIMEType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] string <b>MIMEType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the MIME-type of the document's resource </dd> <dd><p> 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. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Language" class="membertitle">Language</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a> <b>Language</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>default language of the document </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ModifiedBy" class="membertitle">ModifiedBy</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ModifiedBy</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the name of the editor who was the last person to store this document </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ModifyDate" class="membertitle">ModifyDate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/DateTime.html">DateTime</a> <b>ModifyDate</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the date and time of the last time the document was stored </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PrintDate" class="membertitle">PrintDate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/DateTime.html">DateTime</a> <b>PrintDate</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the date and time of when the document was last printed </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PrintedBy" class="membertitle">PrintedBy</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>PrintedBy</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the name of the editor who was the last person to print the document </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Subject" class="membertitle">Subject</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Subject</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>subject of document </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Template" class="membertitle">Template</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Template</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains logical name of the template from which the document was created </dd> <dd><p> The value is an empty string if the document was not created from a template or if it was detached from the template. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TemplateFileName" class="membertitle">TemplateFileName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>TemplateFileName</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the file path name of the template from which the document was created </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TemplateDate" class="membertitle">TemplateDate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/DateTime.html">DateTime</a> <b>TemplateDate</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the date and time of when the document was created or updated from the template </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Title" class="membertitle">Title</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Title</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the title of the document </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>