Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 8043

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XNumberFormats</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="XNumberFormats-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Number_Formats" class="navimain">Devguide</a></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">util</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XNumberFormats</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to multiple <a href="NumberFormat.html">NumberFormat</a>s.
 </dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Number_Formats">OfficeDev - Number Formats</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="#getByKey">getByKey</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#queryKeys">queryKeys</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#queryKey">queryKey</a></td>
<td class="imsum_right">finds a number format by its format string and returns its key.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addNew">addNew</a></td>
<td class="imsum_right">adds a new number format to the list, using a format string.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addNewConverted">addNewConverted</a></td>
<td class="imsum_right">adds a new number format to the list, using a format 
 string in a different locale than the desired locale of the 
 resulting number format.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#removeByKey">removeByKey</a></td>
<td class="imsum_right">removes a number format from the list.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#generateFormat">generateFormat</a></td>
<td class="imsum_right">generates a format string from several parameters without
 creating an actual number format.
 &nbsp;</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="getByKey" class="membertitle">getByKey</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/XPropertySet.html">XPropertySet</a></td>
</tr>
<tr>
<td valign="top"><b>getByKey</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nKey );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>a readonly <a href="NumberFormatProperties.html">NumberFormatProperties</a>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="queryKeys" class="membertitle">queryKeys</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">sequence&lt; long &gt;</td>
</tr>
<tr>
<td valign="top"><b>queryKeys</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nType,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;nLocale,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;bCreate );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>a sequence of the keys of all number formats with the specified type and language. 
 
 </dd>
<dt><b>Parameter nType</b></dt>
<dd>the type of number formats to return. Must be one of the 
 <a href="NumberFormat.html">NumberFormat</a> constants. 
 
 </dd>
<dt><b>Parameter nLanguage</b></dt>
<dd>the language of number formats to return. 
 
 </dd>
<dt><b>Parameter bCreate</b></dt>
<dd><b>true</b>: create new entries if no formats for the selected language exist<BR> 
 <b>false</b>: return an empty list if no formats for the selected language exist
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="queryKey" class="membertitle">queryKey</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">long</td>
</tr>
<tr>
<td valign="top"><b>queryKey</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aFormat,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;nLocale,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;bScan );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>finds a number format by its format string and returns its key.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addNew" class="membertitle">addNew</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">long</td>
</tr>
<tr>
<td valign="top"><b>addNew</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aFormat,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;nLocale )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="MalformedNumberFormatException.html">MalformedNumberFormatException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>adds a new number format to the list, using a format string.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addNewConverted" class="membertitle">addNewConverted</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">long</td>
</tr>
<tr>
<td valign="top"><b>addNewConverted</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aFormat,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;nLocale,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;nNewLocale )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="MalformedNumberFormatException.html">MalformedNumberFormatException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>adds a new number format to the list, using a format 
 string in a different locale than the desired locale of the 
 resulting number format.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="removeByKey" class="membertitle">removeByKey</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>removeByKey</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nKey );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>removes a number format from the list.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="generateFormat" class="membertitle">generateFormat</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>generateFormat</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nBaseKey,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;nLocale,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;bThousands,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;bRed,</td>
</tr>
<tr>
<td/><td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nDecimals,</td>
</tr>
<tr>
<td/><td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nLeading );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>generates a format string from several parameters without
 creating an actual number format.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 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>