<html> <head> <title>Service BaseIndex</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="BaseIndex-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Indexes_and_Index_Marks" 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">Services' Summary</td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub">Services' Details</td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</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 BaseIndex</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies the basic service of different indexes within a document.</dd> <dt><b>See also</b></dt> <dd><a href="DocumentIndex.html">DocumentIndex</a>, <a href="ContentIndex.html">ContentIndex</a>, <a href="UserDefinedIndex.html">UserDefinedIndex</a>, com::sun::star::text::IllustrationIndex, <a href="TableIndex.html">TableIndex</a>, <a href="ObjectIndex.html">ObjectIndex</a></dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Indexes_and_Index_Marks">Text - Indexes and Index Marks</a></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"><a href="XDocumentIndex.html">XDocumentIndex</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>This is the main interface for a document index. </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">string<br> <a href="#Title">Title</a></td> <td class="imsum_right">contains the title of the index. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsProtected">IsProtected</a></td> <td class="imsum_right">determins if the index is protected. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ParaStyleHeading">ParaStyleHeading</a></td> <td class="imsum_right">contains the name of the paragraph style that is applied to the heading. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ParaStyleLevel1">ParaStyleLevel1</a></td> <td class="imsum_right">contains the name of the paragraph style that is applied to the 1st level. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ParaStyleLevel2">ParaStyleLevel2</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the name of the paragraph style that is applied to the 2nd level. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ParaStyleLevel3">ParaStyleLevel3</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the name of the paragraph style that is applied to the 3rd level. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ParaStyleLevel4">ParaStyleLevel4</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the name of the paragraph style that is applied to the 4th level. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ParaStyleLevel5">ParaStyleLevel5</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the name of the paragraph style that is applied to the 5th level. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ParaStyleLevel6">ParaStyleLevel6</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the name of the paragraph style that is applied to the 6th level. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ParaStyleLevel7">ParaStyleLevel7</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the name of the paragraph style that is applied to the 7th level. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ParaStyleLevel8">ParaStyleLevel8</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the name of the paragraph style that is applied to the 8th level. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ParaStyleLevel9">ParaStyleLevel9</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the name of the paragraph style that is applied to the 9th level. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ParaStyleLevel10">ParaStyleLevel10</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the name of the paragraph style that is applied to the 10th level. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ParaStyleSeparator">ParaStyleSeparator</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the name of the paragraph style that is applied to the separator level. </td> </tr> <tr> <td class="imsum_left"><a href="XTextColumns.html">XTextColumns</a><br> <a href="#TextColumns">TextColumns</a></td> <td class="imsum_right">contains the column interface. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#BackGraphicURL">BackGraphicURL</a></td> <td class="imsum_right">contains the URL of a graphic file that is displayed as background graphic </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#BackGraphicFilter">BackGraphicFilter</a></td> <td class="imsum_right">contains the name of the filter of the graphic file that is displayed as background graphic </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../style/module-ix.html">style</a>::<a href="../style/GraphicLocation.html">GraphicLocation</a><br> <a href="#BackGraphicLocation">BackGraphicLocation</a></td> <td class="imsum_right">determines the position of the background graphic. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a><br> <a href="#BackColor">BackColor</a></td> <td class="imsum_right">specifies the color of the background. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#BackTransparent">BackTransparent</a></td> <td class="imsum_right">If <b>true</b>, the background color value in "BackColor" is not visible. </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><br> <a href="#LevelFormat">LevelFormat</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>returns the interface of the level format of the index. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CreateFromChapter">CreateFromChapter</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determins if the content of the document index is created from the complete document content or from the current chapter only. </td> </tr> <tr> <td class="imsum_left"><a href="XTextSection.html">XTextSection</a><br> <a href="#ContentSection">ContentSection</a></td> <td class="imsum_right">the text section containing the content of the index </td> </tr> <tr> <td class="imsum_left"><a href="XTextSection.html">XTextSection</a><br> <a href="#HeaderSection">HeaderSection</a></td> <td class="imsum_right">the text section containing the header of the index </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="XDocumentIndex" class="membertitle"><a href="XDocumentIndex.html">XDocumentIndex</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 main interface for a document index. </dd> </dl> </td> </tr> </table> </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="Title" class="membertitle">Title</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Title</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the title of the index.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsProtected" class="membertitle">IsProtected</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsProtected</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determins if the index is protected.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaStyleHeading" class="membertitle">ParaStyleHeading</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ParaStyleHeading</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the name of the paragraph style that is applied to the heading.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaStyleLevel1" class="membertitle">ParaStyleLevel1</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ParaStyleLevel1</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the name of the paragraph style that is applied to the 1st level.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaStyleLevel2" class="membertitle">ParaStyleLevel2</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ParaStyleLevel2</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the name of the paragraph style that is applied to the 2nd level.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaStyleLevel3" class="membertitle">ParaStyleLevel3</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ParaStyleLevel3</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the name of the paragraph style that is applied to the 3rd level.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaStyleLevel4" class="membertitle">ParaStyleLevel4</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ParaStyleLevel4</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the name of the paragraph style that is applied to the 4th level.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaStyleLevel5" class="membertitle">ParaStyleLevel5</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ParaStyleLevel5</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the name of the paragraph style that is applied to the 5th level.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaStyleLevel6" class="membertitle">ParaStyleLevel6</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ParaStyleLevel6</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the name of the paragraph style that is applied to the 6th level.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaStyleLevel7" class="membertitle">ParaStyleLevel7</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ParaStyleLevel7</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the name of the paragraph style that is applied to the 7th level.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaStyleLevel8" class="membertitle">ParaStyleLevel8</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ParaStyleLevel8</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the name of the paragraph style that is applied to the 8th level.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaStyleLevel9" class="membertitle">ParaStyleLevel9</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ParaStyleLevel9</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the name of the paragraph style that is applied to the 9th level.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaStyleLevel10" class="membertitle">ParaStyleLevel10</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ParaStyleLevel10</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the name of the paragraph style that is applied to the 10th level.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParaStyleSeparator" class="membertitle">ParaStyleSeparator</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ParaStyleSeparator</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the name of the paragraph style that is applied to the separator level.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TextColumns" class="membertitle">TextColumns</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="XTextColumns.html">XTextColumns</a> <b>TextColumns</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the column interface.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BackGraphicURL" class="membertitle">BackGraphicURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>BackGraphicURL</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the URL of a graphic file that is displayed as background graphic</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BackGraphicFilter" class="membertitle">BackGraphicFilter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>BackGraphicFilter</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the name of the filter of the graphic file that is displayed as background graphic</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BackGraphicLocation" class="membertitle">BackGraphicLocation</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="../style/module-ix.html">style</a>::<a href="../style/GraphicLocation.html">GraphicLocation</a> <b>BackGraphicLocation</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines the position of the background graphic.</dd> <dt><b>See also</b></dt> <dd><a href="#GraphicLocation">GraphicLocation</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BackColor" class="membertitle">BackColor</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="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>BackColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the color of the background. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BackTransparent" class="membertitle">BackTransparent</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>BackTransparent</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If <b>true</b>, the background color value in "BackColor" is not visible. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="LevelFormat" class="membertitle">LevelFormat</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="../container/module-ix.html">container</a>::<a href="../container/XIndexReplace.html">XIndexReplace</a> <b>LevelFormat</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>returns the interface of the level format of the index. </dd> <dd><p> The description of the format of the levels depends on the type of the document index. </p> </dd> <dt><b>See also</b></dt> <dd><a href="DocumentIndexLevelFormat.html">DocumentIndexLevelFormat</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CreateFromChapter" class="membertitle">CreateFromChapter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CreateFromChapter</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determins if the content of the document index is created from the complete document content or from the current chapter only. </dd> <dd><p> It is not available in the bibliography</p></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ContentSection" class="membertitle">ContentSection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="XTextSection.html">XTextSection</a> <b>ContentSection</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>the text section containing the content of the index </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HeaderSection" class="membertitle">HeaderSection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="XTextSection.html">XTextSection</a> <b>HeaderSection</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>the text section containing the header of the index </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 © 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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
6703
