<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="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</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>Description</b></dt> <dd>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. </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="#getCustomProperties">getCustomProperties</a></td> <td class="imsum_right">returns a container for custom 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="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="getCustomProperties" class="membertitle">getCustomProperties</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>getCustomProperties</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns a container for custom properties </dd> <dd><p> </p> </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 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/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> </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/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 also but because often no other parameters exept the URL are needed providing it separately was added for convenience reasons. </p> </dd> <dt><b>Parameter Medium</b></dt> <dd>the ::com.sun.star.document.MediaDescriptor representing the source </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 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/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. </p> </dd> <dt><b>Parameter Storage</b></dt> <dd>the ::com.sun.star.embed.Storage representing the ODF package </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="../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 also but because often no other parameters exept the URL are needed providing it separately was added for convenience reasons. </p> </dd> <dt><b>Parameter Medium</b></dt> <dd>the ::com.sun.star.document.MediaDescriptor representing the target </dd> </dl> </td> </tr> </table> </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 of the first time the document was stored </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 document </td> </tr> <tr> <td class="imsum_left"><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"><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"><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"><a href="#Language">Language</a></td> <td class="imsum_right">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 editor who was the last person to store this document </td> </tr> <tr> <td class="imsum_left"><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"><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"><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"><a href="#Template">Template</a></td> <td class="imsum_right">contains the path and name 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 after 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> </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 of the first time the document was stored </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 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 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="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="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="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="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 the path and 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="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 after 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 AutoloadSecs. An empty string together with an AutoLoadSecs value of 0 describes a case where no AutoLoad is specified. </p> </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> <dd><p> 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. </p> </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> </table> <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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
2407
