Sophie

Sophie

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

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

<html>
<head>
<title>Constants' Group ReferenceFieldPart</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="navimainnone">Use</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="#Constants" class="navisub">Constants</a></td>
<td class="navisub"><a href="#ConstantDetails" class="navisub">Constants' 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">text</a> :: </p>
</td>
</tr>
<tr>
<td class="title">constants group ReferenceFieldPart</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>These constants define how the reference position is displayed in
 reference text fields.

</dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="Constants"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Constants</td>
</tr>
<tr>
<td class="imsum_left"><a href="#PAGE">PAGE</a></td>
<td class="imsum_right">The page number is displayed using arabic numbers.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#CHAPTER">CHAPTER</a></td>
<td class="imsum_right">The number of the chapter is displayed.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#TEXT">TEXT</a></td>
<td class="imsum_right">The reference text is displayed.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#UP_DOWN">UP_DOWN</a></td>
<td class="imsum_right">The reference is displayed as one of the (localized) words, "above" or "below".
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#PAGE_DESC">PAGE_DESC</a></td>
<td class="imsum_right">The page number is displayed using the numbering type defined in
 the page style of the reference position.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#CATEGORY_AND_NUMBER">CATEGORY_AND_NUMBER</a></td>
<td class="imsum_right">The category and the number of a caption is displayed.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#ONLY_CAPTION">ONLY_CAPTION</a></td>
<td class="imsum_right">The caption text of a caption is displayed.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#ONLY_SEQUENCE_NUMBER">ONLY_SEQUENCE_NUMBER</a></td>
<td class="imsum_right">The number of a sequence field is displayed.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#NUMBER">NUMBER</a></td>
<td class="imsum_right">The numbering label and depending of the reference field context numbering lables of
 superior list levels of the reference are displayed.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#NUMBER_NO_CONTEXT">NUMBER_NO_CONTEXT</a></td>
<td class="imsum_right">The numbering label of the reference is displayed.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#NUMBER_FULL_CONTEXT">NUMBER_FULL_CONTEXT</a></td>
<td class="imsum_right">The numbering label and numbering lables of superior list levels of the reference are displayed.

 &nbsp;</td>
</tr>
</table>
<a name="ConstantDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Constants' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="PAGE" class="membertitle">PAGE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>const short <b>PAGE</b> = 0;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The page number is displayed using arabic numbers.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="CHAPTER" class="membertitle">CHAPTER</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>const short <b>CHAPTER</b> = 1;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The number of the chapter is displayed.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="TEXT" class="membertitle">TEXT</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>const short <b>TEXT</b> = 2;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The reference text is displayed.
 </dd>
<dd><p>If the source of the reference is a sequence field, then the complete text
 of the paragraph is displayed. This is useful to reference to captions. </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="UP_DOWN" class="membertitle">UP_DOWN</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>const short <b>UP_DOWN</b> = 3;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The reference is displayed as one of the (localized) words, "above" or "below".
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="PAGE_DESC" class="membertitle">PAGE_DESC</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>const short <b>PAGE_DESC</b> = 4;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The page number is displayed using the numbering type defined in
 the page style of the reference position.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="CATEGORY_AND_NUMBER" class="membertitle">CATEGORY_AND_NUMBER</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>const short <b>CATEGORY_AND_NUMBER</b> = 5;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The category and the number of a caption is displayed.
 </dd>
<dd><p>This option is only valid if the source of the reference is a sequence field.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ONLY_CAPTION" class="membertitle">ONLY_CAPTION</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>const short <b>ONLY_CAPTION</b> = 6;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The caption text of a caption is displayed.
 </dd>
<dd><p>This option is only valid if the source of the reference is a sequence field.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ONLY_SEQUENCE_NUMBER" class="membertitle">ONLY_SEQUENCE_NUMBER</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>const short <b>ONLY_SEQUENCE_NUMBER</b> = 7;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The number of a sequence field is displayed.
 </dd>
<dd><p>This option is only valid if the source of the reference is a sequence field.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="NUMBER" class="membertitle">NUMBER</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>const short <b>NUMBER</b> = 8;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The numbering label and depending of the reference field context numbering lables of
 superior list levels of the reference are displayed.

 </dd>
<dd><p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
 <p>The contents of the list label of the paragraph, at which the bookmark respectively the
 set reference starts - named "referenced item" in the following - is displayed. To unambiguous
 identify the referenced item at the document position of the reference text field, the content
 of all needed superior levels are added in front. The needed superior levels of the referenced
 item are the ones, which differ from the superior levels of the document position of the reference
 text field.
 Additional condition, which suppresses the addition of a superior level's list label content:
 The list label of the referenced item can already contain numbers of a superior levels. Assume X
 be the level of the most superior level, then no list label content of superior levels greater or
 equal than X are added.
 If the referenced item isn't numbered, nothing is displayed.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 3.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="NUMBER_NO_CONTEXT" class="membertitle">NUMBER_NO_CONTEXT</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>const short <b>NUMBER_NO_CONTEXT</b> = 9;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The numbering label of the reference is displayed.

 </dd>
<dd><p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
 <p>The contents of the list label of the paragraph, at which the bookmark respectively the
 set reference starts, is displayed. If this paragraph isn't numbered, nothing is displayed.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 3.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="NUMBER_FULL_CONTEXT" class="membertitle">NUMBER_FULL_CONTEXT</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>const short <b>NUMBER_FULL_CONTEXT</b> = 10;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The numbering label and numbering lables of superior list levels of the reference are displayed.

 </dd>
<dd><p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
 <p>The contents of the list label of the paragraph, at which the bookmark respectively the
 set reference starts - named "referenced item" in the following - is displayed and the contents
 of all list labels of superior levels are added in front of it.
 Additional condition, which suppresses the addition of a superior level's list label content:
 The list label of the referenced item can already contain numbers of a superior levels. Assume X
 be the level of the most superior level, then no list label content of superior levels greater or
 equal than X are added.
 If the referenced item is numbered nothing is displayed.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 3.0</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>