Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: text ::

service DocumentIndex
Description
specifies service of content indexes within a document.
See also
BaseIndex

Included Services - Summary
BaseIndex
(referenced entity's summary:)
specifies the basic service of different indexes within a document.
Properties' Summary
boolean
UseAlphabeticalSeparators
[ OPTIONAL ]
determins if alphabetical separators are genererated.  
boolean
UseKeyAsEntry
[ OPTIONAL ]
determins if a index entry is generated for each primary/secondary key.  
boolean
UseCombinedEntries
[ OPTIONAL ]
determins if same entries on different pages are combined into one index entry.  
boolean
IsCaseSensitive
[ OPTIONAL ]
determins if the similarity of index entries is checked case sensitively.  
boolean
UsePP
[ OPTIONAL ]
determins if following page numbers are displayed using a 'pp.'.  
boolean
UseDash
[ OPTIONAL ]
determins if if following page numbers are displayed using a dash.  
boolean
UseUpperCase
[ OPTIONAL ]
determins if all entries start with a capital letter.  
string
MainEntryCharacterStyleName
[ OPTIONAL ]
determins the name of the character style that is applied to the number of a page where main index entry is located.  
[ readonly ] sequence< XDocumentIndexMark >
DocumentIndexMarks
contains all index marks that are related to this index.  
::com::sun::star::lang::Locale
Locale
contains the locale of the index.  
string
SortAlgorithm
contains the name of the sort algorithm that is used to sort the entries.  
Included Services - Details
BaseIndex
(referenced entity's summary:)
specifies the basic service of different indexes within a document.
Properties' Details
UseAlphabeticalSeparators
boolean UseAlphabeticalSeparators;
Usage Restrictions
optional
Description
determins if alphabetical separators are genererated.
UseKeyAsEntry
boolean UseKeyAsEntry;
Usage Restrictions
optional
Description
determins if a index entry is generated for each primary/secondary key.
UseCombinedEntries
boolean UseCombinedEntries;
Usage Restrictions
optional
Description
determins if same entries on different pages are combined into one index entry.
IsCaseSensitive
boolean IsCaseSensitive;
Usage Restrictions
optional
Description
determins if the similarity of index entries is checked case sensitively.
UsePP
boolean UsePP;
Usage Restrictions
optional
Description
determins if following page numbers are displayed using a 'pp.'.
UseDash
boolean UseDash;
Usage Restrictions
optional
Description
determins if if following page numbers are displayed using a dash.
UseUpperCase
boolean UseUpperCase;
Usage Restrictions
optional
Description
determins if all entries start with a capital letter.
MainEntryCharacterStyleName
string MainEntryCharacterStyleName;
Usage Restrictions
optional
Description
determins the name of the character style that is applied to the number of a page where main index entry is located.
DocumentIndexMarks
[ readonly ] sequence< XDocumentIndexMark > DocumentIndexMarks;
Description
contains all index marks that are related to this index.
Locale
::com::sun::star::lang::Locale Locale;
Description
contains the locale of the index.
SortAlgorithm
string SortAlgorithm;
Description
contains the name of the sort algorithm that is used to sort the entries.

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.