<html> <head> <title>Interface XDocumentInfo</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="XDocumentInfo-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">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</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">deprecated </td> <td width="50%" class="title">interface XDocumentInfo</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Deprecation Info</b></dt> <dd>Use <a href="XDocumentProperties.html">XDocumentProperties</a> instead. </dd> <dt><b>Description</b></dt> <dd>provides access to the user fields for the information regarding the document </dd> <dd><p> These fields are special one of the set of available document properties. Other ones are accessed as properties (by using the interface ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a>) of service <a href="DocumentInfo.html">DocumentInfo</a>. </p> </dd> <dt><b>See also</b></dt> <dd><a href="DocumentInfo.html">DocumentInfo</a>, <a href="StandaloneDocumentInfo.html">StandaloneDocumentInfo</a>, ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></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="#getUserFieldCount">getUserFieldCount</a></td> <td class="imsum_right">provides information about count of available fields </td> </tr> <tr> <td class="imsum_left"><a href="#getUserFieldName">getUserFieldName</a></td> <td class="imsum_right">returns the name of an user field </td> </tr> <tr> <td class="imsum_left"><a href="#getUserFieldValue">getUserFieldValue</a></td> <td class="imsum_right">returns the value of an user field </td> </tr> <tr> <td class="imsum_left"><a href="#setUserFieldName">setUserFieldName</a></td> <td class="imsum_right">changes the name of one of the user fields </td> </tr> <tr> <td class="imsum_left"><a href="#setUserFieldValue">setUserFieldValue</a></td> <td class="imsum_right">changes the value of one of the user fields </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="getUserFieldCount" class="membertitle">getUserFieldCount</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">short</td> </tr> <tr> <td valign="top"><b>getUserFieldCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides information about count of available fields </dd> <dd><p> This count marks the top range of possible requests for get/set any of these fields. Range = [0..count-1] </p> </dd> <dt><b>Returns</b></dt> <dd>current count </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getUserFieldName" class="membertitle">getUserFieldName</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">string</td> </tr> <tr> <td valign="top"><b>getUserFieldName</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> Index )</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/ArrayIndexOutOfBoundsException.html">ArrayIndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the name of an user field </dd> <dt><b>Parameter Index</b></dt> <dd>specifies the position of requested field Range = [0..count-1] </dd> <dt><b>Returns</b></dt> <dd>the name of the requested field </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::ArrayIndexOutOfBoundsException if <var>Index</var> don't fit range of [0..count-1] </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getUserFieldValue" class="membertitle">getUserFieldValue</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">string</td> </tr> <tr> <td valign="top"><b>getUserFieldValue</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> Index )</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/ArrayIndexOutOfBoundsException.html">ArrayIndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the value of an user field </dd> <dt><b>Parameter Index</b></dt> <dd>specifies the position of requested field Range = [0..count-1] </dd> <dt><b>Returns</b></dt> <dd>the value of the requested field </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::ArrayIndexOutOfBoundsException if <var>Index</var> don't fit range of [0..count-1] </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setUserFieldName" class="membertitle">setUserFieldName</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>setUserFieldName</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> Index,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> Name )</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/ArrayIndexOutOfBoundsException.html">ArrayIndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>changes the name of one of the user fields </dd> <dt><b>Parameter Index</b></dt> <dd>specifies the position of requested field Range = [0..count-1] </dd> <dt><b>Parameter Name</b></dt> <dd>the new name for this field to be set </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::ArrayIndexOutOfBoundsException if <var>Index</var> don't fit range of [0..count-1] </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setUserFieldValue" class="membertitle">setUserFieldValue</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>setUserFieldValue</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> Index,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> Value )</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/ArrayIndexOutOfBoundsException.html">ArrayIndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>changes the value of one of the user fields </dd> <dt><b>Parameter Index</b></dt> <dd>specifies the position of requested field Range = [0..count-1] </dd> <dt><b>Parameter Value</b></dt> <dd>the new value for this field to be set </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::ArrayIndexOutOfBoundsException if <var>Index</var> don't fit range of [0..count-1] </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
