Sophie

Sophie

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

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

<html>
<head>
<title>Service DocumentIndexLevelFormat</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="DocumentIndexLevelFormat-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">Services' Summary</td>
<td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td>
<td class="navisub">Properties' Summary</td>
<td class="navisub">Services' Details</td>
<td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td>
<td class="navisub">Properties' 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">text</a> :: </p>
</td>
</tr>
<tr>
<td class="title">service DocumentIndexLevelFormat</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>This service provides access to the structure of the levels of document indexes.
 
 
 </dd>
<dd><p>
 The element type is Sequence&lt; PropertyValues &gt;. Each element in this sequence represents
 a member of an index line. The following properties are part of such an element.
 </p>
 <ul>
 <li>
 <p>TokenType</p>
 <p>Values:</p>
 <ul>
 <li>
 <p>TokenEntryNumber - chapter number, used in content indexes
 only</p>
 </li>
 <li>
 <p>TokenEntryText - text of the entry
 </p>
 </li>
 <li>
 <p>TokenTabStop - tab stop
 </p>
 </li>
 <li>
 <p>TokenText - user defined text
 </p>
 </li>
 <li>
 <p>TokenPageNumber - page number
 </p>
 </li>
 <li>
 <p>TokenChapterInfo - chapter info, in illustration indexes,
 table indexes, user indexes, table of objects and alphabetical indexes
 only</p>
 </li>
 <li>
 <p>TokenHyperlinkStart - start of a hyperlink</p>
 </li>
 <li>
 <p>TokenHyperlinkEnd - end of a hyperlink</p>
 </li>
 <li>
 <p>TokenBibliographyDataField - bibliographic data field
 </p>
 </li>
 </ul>
 </li>
 <li>
 <p>CharacterStyleName</p>
 <p>Name of the character style applied to the element. Invalid in tab stops.</p>
 </li>
 <li>
 <p>TabStopRightAligned</p>
 <p>Tab stop is right aligned. Only valid for tab stops.</p>
 </li>
 <li>
 <p>TabStopPosition</p>
 <p>Position of the tab stop. Only valid for tab stops.</p>
 </li>
 <li>
 <p>TabStopFillCharacter</p>
 <p>Fill character in tab stops. Only valid for tab stops.</p>
 </li>
 <li>
 <p>WithTab</p>
 <p>If true insert tab character.</p>
 </li>
 <li>
 <p>Text</p>
 <p>Text. Only valid in user defined text.</p>
 </li>
 <li>
 <p>ChapterFormat</p>
 <p>Valid in chapter info and entry number only. See <a href="ChapterFormat.html">ChapterFormat</a>.</p>
 <p>Other information.</p>
 <ul>
 <li>
 <p>In chapter info only com.sun.star.text.ChapterFormat.NUMBER, com.sun.star.text.ChapterFormat.NAME, and
 com.sun.star.text.ChapterFormat.NAME_NUMBER constants are allowed.</p>
 </li>
 <li>
 <p>In entry number only com.sun.star.text.ChapterFormat.NUMBER and com.sun.star.text.ChapterFormat.DIGIT constants are allowed.</p>
 </li>
 </ul>
 </li>
 <li>
 <p>ChapterLevel</p>
 <p>Valid in chapter info and entry number only. Denotes the level up to which
 the chapter information is given. Values permitted 1 to 10 inclusive.</p>
 </li>
 </ul>
 </dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Summary</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexReplace.html">XIndexReplace</a></td>
<td class="imsum_right"><dl>
<dt>(referenced entity's summary:)</dt>
<dd>This is the generic interface for supporting the replacement of indexed
 elements.
 </dd>
</dl>
</td>
</tr>
</table>
<a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Details</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XIndexReplace" class="membertitle">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexReplace.html">XIndexReplace</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt>(referenced entity's summary:)</dt>
<dd>This is the generic interface for supporting the replacement of indexed
 elements.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br>&nbsp;<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>