<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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</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">interface XDocumentInfo</td> </tr> <tr> <td/></tr> <tr> <td><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 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 © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
2399
