<html> <head> <title>Service DocumentIndex</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="DocumentIndex-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="#IncludedServices" class="navisub">Included Services</a></td> <td class="navisub">Exported Interfaces</td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' 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">service DocumentIndex</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies service of content indexes within a document.</dd> <dt><b>See also</b></dt> <dd><a href="BaseIndex.html">BaseIndex</a></dd> </dl> </td> </tr> </table> <hr> <a name="IncludedServices"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services</td> </tr> <tr> <td class="imsum_left"><a href="BaseIndex.html">BaseIndex</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies the basic service of different indexes within a document.</dd> </dl> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#UseAlphabeticalSeparators">UseAlphabeticalSeparators</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determins if alphabetical separators are genererated. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#UseKeyAsEntry">UseKeyAsEntry</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determins if a index entry is generated for each primary/secondary key. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#UseCombinedEntries">UseCombinedEntries</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determins if same entries on different pages are combined into one index entry. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsCaseSensitive">IsCaseSensitive</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determins if the similarity of index entries is checked case sensitively. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#UsePP">UsePP</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determins if following page numbers are displayed using a 'pp.'. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#UseDash">UseDash</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determins if if following page numbers are displayed using a dash. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#UseUpperCase">UseUpperCase</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determins if all entries start with a capital letter. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#MainEntryCharacterStyleName">MainEntryCharacterStyleName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determins the name of the character style that is applied to the number of a page where main index entry is located. </td> </tr> <tr> <td class="imsum_left">[ readonly ] sequence< <a href="XDocumentIndexMark.html">XDocumentIndexMark</a> ><br> <a href="#DocumentIndexMarks">DocumentIndexMarks</a></td> <td class="imsum_right">contains all index marks that are related to this index. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a><br> <a href="#Locale">Locale</a></td> <td class="imsum_right">contains the locale of the index. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#SortAlgorithm">SortAlgorithm</a></td> <td class="imsum_right">contains the name of the sort algorithm that is used to sort the entries. </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="UseAlphabeticalSeparators" class="membertitle">UseAlphabeticalSeparators</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>UseAlphabeticalSeparators</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determins if alphabetical separators are genererated. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UseKeyAsEntry" class="membertitle">UseKeyAsEntry</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>UseKeyAsEntry</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determins if a index entry is generated for each primary/secondary key. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UseCombinedEntries" class="membertitle">UseCombinedEntries</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>UseCombinedEntries</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determins if same entries on different pages are combined into one index entry. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsCaseSensitive" class="membertitle">IsCaseSensitive</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsCaseSensitive</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determins if the similarity of index entries is checked case sensitively. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UsePP" class="membertitle">UsePP</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>UsePP</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determins if following page numbers are displayed using a 'pp.'. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UseDash" class="membertitle">UseDash</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>UseDash</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determins if if following page numbers are displayed using a dash. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UseUpperCase" class="membertitle">UseUpperCase</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>UseUpperCase</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determins if all entries start with a capital letter. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MainEntryCharacterStyleName" class="membertitle">MainEntryCharacterStyleName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>MainEntryCharacterStyleName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determins the name of the character style that is applied to the number of a page where main index entry is located. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DocumentIndexMarks" class="membertitle">DocumentIndexMarks</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] sequence< <a href="XDocumentIndexMark.html">XDocumentIndexMark</a> > <b>DocumentIndexMarks</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains all index marks that are related to this index. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Locale" class="membertitle">Locale</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a> <b>Locale</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the locale of the index. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SortAlgorithm" class="membertitle">SortAlgorithm</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>SortAlgorithm</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the name of the sort algorithm that is used to sort the entries. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <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
>
6425
