<html> <head> <title>Interface XDocumentProperties</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="XDocumentProperties-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"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' 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"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XDocumentProperties</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>provides document-specific information such as the author, creation date, and user-defined fields. </dd> <dd><p> 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 <a href="XDocumentProperties.html#loadFromStorage">loadFromStorage</a> and <a href="XDocumentProperties.html#loadFromMedium">loadFromMedium</a>. The properties may also be stored via the methods <a href="XDocumentProperties.html#storeToStorage">storeToStorage</a> and <a href="XDocumentProperties.html#storeToMedium">storeToMedium</a>. </p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.0</dd> <dt><b>See also</b></dt> <dd><a href="XDocumentPropertiesSupplier.html">XDocumentPropertiesSupplier</a><br> for getting access to an instance from a loaded document </dd> <dt><b>See also</b></dt> <dd><a href="DocumentProperties.html">DocumentProperties</a><br> for a service that implements this interface </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#resetUserData">resetUserData</a></td> <td class="imsum_right">resets all attributes that could identify the user. </td> </tr> <tr> <td class="imsum_left"><a href="#getUserDefinedProperties">getUserDefinedProperties</a></td> <td class="imsum_right">provides access to a container for user-defined properties. </td> </tr> <tr> <td class="imsum_left"><a href="#loadFromStorage">loadFromStorage</a></td> <td class="imsum_right">loads document properties from an ODF package. </td> </tr> <tr> <td class="imsum_left"><a href="#loadFromMedium">loadFromMedium</a></td> <td class="imsum_right">loads document properties from an ODF package or an OLE container. </td> </tr> <tr> <td class="imsum_left"><a href="#storeToStorage">storeToStorage</a></td> <td class="imsum_right">stores document properties to an ODF package. </td> </tr> <tr> <td class="imsum_left"><a href="#storeToMedium">storeToMedium</a></td> <td class="imsum_right">stores document properties to an ODF package or an OLE container. </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#Author">Author</a></td> <td class="imsum_right">contains the initial author of the document. </td> </tr> <tr> <td class="imsum_left"><a href="#Generator">Generator</a></td> <td class="imsum_right">identifies which application was used to create or last modify the document. </td> </tr> <tr> <td class="imsum_left"><a href="#CreationDate">CreationDate</a></td> <td class="imsum_right">contains the date and time when the document was created. </td> </tr> <tr> <td class="imsum_left"><a href="#Title">Title</a></td> <td class="imsum_right">contains the title of the document. </td> </tr> <tr> <td class="imsum_left"><a href="#Subject">Subject</a></td> <td class="imsum_right">contains the subject of the document. </td> </tr> <tr> <td class="imsum_left"><a href="#Description">Description</a></td> <td class="imsum_right">contains a multi-line comment describing the document. </td> </tr> <tr> <td class="imsum_left"><a href="#Keywords">Keywords</a></td> <td class="imsum_right">contains a list of keywords for the document. </td> </tr> <tr> <td class="imsum_left"><a href="#Language">Language</a></td> <td class="imsum_right">contains the default language of the document. </td> </tr> <tr> <td class="imsum_left"><a href="#ModifiedBy">ModifiedBy</a></td> <td class="imsum_right">contains the name of the person who most recently stored the document. </td> </tr> <tr> <td class="imsum_left"><a href="#ModificationDate">ModificationDate</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"><a href="#PrintedBy">PrintedBy</a></td> <td class="imsum_right">contains the name of the person who most recently printed the document. </td> </tr> <tr> <td class="imsum_left"><a href="#PrintDate">PrintDate</a></td> <td class="imsum_right">contains the date and time when the document was last printed. </td> </tr> <tr> <td class="imsum_left"><a href="#TemplateName">TemplateName</a></td> <td class="imsum_right">contains the name of the template from which the document was created. </td> </tr> <tr> <td class="imsum_left"><a href="#TemplateURL">TemplateURL</a></td> <td class="imsum_right">contains the URL of the template from which the document was created. </td> </tr> <tr> <td class="imsum_left"><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"><a href="#AutoloadURL">AutoloadURL</a></td> <td class="imsum_right">contains the URL to load automatically at a specified time after the document is loaded into a desktop frame. </td> </tr> <tr> <td class="imsum_left"><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"><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"><a href="#DocumentStatistics">DocumentStatistics</a></td> <td class="imsum_right">contains some statistics about the document. </td> </tr> <tr> <td class="imsum_left"><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"><a href="#EditingDuration">EditingDuration</a></td> <td class="imsum_right">contains the net time of editing the document (in seconds). </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="resetUserData" class="membertitle">resetUserData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>resetUserData</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> Author );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>resets all attributes that could identify the user. </dd> <dd><p> Clears the document properties, such that it apperars the document has just been created. This is a convenience method which resets several attributes at once, as follows: <ul> <li><a href="#Author">Author</a> is set to the given parameter.</li> <li><a href="#CreationDate">CreationDate</a> is set to the current date and time. </li> <li><a href="#ModifiedBy">ModifiedBy</a> is cleared.</li> <li><a href="#ModificationDate">ModificationDate</a> is cleared.</li> <li><a href="#PrintedBy">PrintedBy</a> is cleared.</li> <li><a href="#PrintDate">PrintDate</a> is cleared.</li> <li><a href="#EditingDuration">EditingDuration</a> is cleared.</li> <li><a href="#EditingCycles">EditingCycles</a> is set to 1.</li> </ul> </dd> <dt><b>Parameter Author</b></dt> <dd>the new value of the <a href="#Author">Author</a> attribute. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getUserDefinedProperties" class="membertitle">getUserDefinedProperties</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertyContainer.html">XPropertyContainer</a></td> </tr> <tr> <td valign="top"><b>getUserDefinedProperties</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides access to a container for user-defined properties. </dd> <dd><p> The returned object also implements the interface com::sun::star::beans::XPropertySet. </p> </dd> <dt><b>Returns</b></dt> <dd>a container that provides access to user-defined properties </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="loadFromStorage" class="membertitle">loadFromStorage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>loadFromStorage</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../embed/module-ix.html">embed</a>::<a href="../embed/XStorage.html">XStorage</a></td> <td valign="bottom"> Storage,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> Medium )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/WrongFormatException.html">WrongFormatException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>loads document properties from an ODF package. </dd> <dd><p> This method is used for accessing an ODF package that is owned by someone else, e.g., a document. </p> </dd> <dt><b>Parameter Storage</b></dt> <dd>the com::sun::star::embed::Storage representing the ODF package </dd> <dt><b>Parameter Medium</b></dt> <dd>the com::sun::star::document::MediaDescriptor representing the source <p> This is unfortunately necessary in order to properly resolve relative URLs in the meta-data. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if argument is <b>NULL</b> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::WrongFormatException if parsing the XML document fails </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if thrown when trying to open a stream in the given storage </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::IOException if thrown when trying to open a stream in the given storage </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::uno::Exception in various unspecified circumstances </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="loadFromMedium" class="membertitle">loadFromMedium</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>loadFromMedium</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> URL,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> Medium )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/WrongFormatException.html">WrongFormatException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>loads document properties from an ODF package or an OLE container. </dd> <dd><p> For compatibility reasons this method also supports the import from former StarOffice binary file formats. </p> </dd> <dt><b>Parameter URL</b></dt> <dd>the URL of the source document <p> 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. </p> </dd> <dt><b>Parameter Medium</b></dt> <dd>the com::sun::star::document::MediaDescriptor representing the source </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::WrongFormatException if parsing the XML document fails </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if thrown when trying to open a stream in the given storage </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::IOException if thrown when trying to open a stream in the given storage </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::uno::Exception in various unspecified circumstances </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="storeToStorage" class="membertitle">storeToStorage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>storeToStorage</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../embed/module-ix.html">embed</a>::<a href="../embed/XStorage.html">XStorage</a></td> <td valign="bottom"> Storage,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> Medium )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>stores document properties to an ODF package. </dd> <dd><p> 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. </p> </dd> <dt><b>Parameter Storage</b></dt> <dd>the com::sun::star::embed::Storage representing the ODF package </dd> <dt><b>Parameter Medium</b></dt> <dd>the com::sun::star::document::MediaDescriptor representing the source <p> This is unfortunately necessary in order to properly resolve relative URLs in the meta-data. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if argument is <b>NULL</b> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if thrown when trying to open a stream in the given storage </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::IOException if thrown when writing to the storage </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::uno::Exception in various unspecified circumstances </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="storeToMedium" class="membertitle">storeToMedium</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>storeToMedium</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> URL,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> Medium )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>stores document properties to an ODF package or an OLE container. </dd> <dd><p> For compatibility reasons this method also supports the export to former StarOffice binary file formats. </p> </dd> <dt><b>Parameter URL</b></dt> <dd>the URL of the target document <p> 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. </p> </dd> <dt><b>Parameter Medium</b></dt> <dd>the com::sun::star::document::MediaDescriptor representing the target </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if thrown when trying to open a stream in the given storage </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::IOException if thrown when writing to the storage </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::uno::Exception in various unspecified circumstances </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' 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 initial author of the document. </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 which application was used to create or last modify the document. </dd> <dd><p> 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. </p> </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 when the document was created. </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> <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>contains the subject of the document. </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 describing 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="Keywords" class="membertitle">Keywords</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>sequence< string > <b>Keywords</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains a list of keywords for the document. </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>contains the 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 person who most recently stored the document. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ModificationDate" class="membertitle">ModificationDate</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>ModificationDate</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the date and time of the last time the document was stored. </dd> <dd><p> If the document has never been stored, contains a default value. </p> </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 person who most recently printed the document. </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 when the document was last printed. </dd> <dd><p> If the document has never been printed, contains a default value. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TemplateName" class="membertitle">TemplateName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>TemplateName</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the name of the template from which the document was created. </dd> <dd><p> The value is an empty <code>string</code> 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="TemplateURL" class="membertitle">TemplateURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>TemplateURL</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the URL of the template from which the document was created. </dd> <dd><p> The value is an empty <code>string</code> 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="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="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 at a specified time after the document is loaded into a desktop frame. </dd> <dd><p> 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 <a href="#AutoloadSecs">AutoloadSecs</a>. An empty <code>string</code> together with an <a href="#AutoloadSecs">AutoloadSecs</a> value of 0 describes a case where no autoload is specified. </p> </dd> <dt><b>See also</b></dt> <dd><a href="#AutoloadSecs">AutoloadSecs</a></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><dl> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <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> <dd><p> A value of 0 is valid and describes a redirection. A value of 0 together with an empty <code>string</code> as <a href="#AutoloadURL">AutoloadURL</a> describes a case where no autoload is specified. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if argument is negative </dd> <dt><b>See also</b></dt> <dd><a href="#AutoloadURL">AutoloadURL</a></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="DocumentStatistics" class="membertitle">DocumentStatistics</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>DocumentStatistics</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains some statistics about the document. </dd> <dd><p> The contained statistics may be specific to the type of the document. </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><dl> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>describes how often the document was edited and saved. </dd> <dd><p> </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if argument is negative </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><dl> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>contains the net time of editing the document (in seconds). </dd> <dd><p> </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if argument is negative </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
2431
