Overview | Module | Use | Devguide | Index

Included Services | Exported Interfaces | Properties' Summary | Properties' Details

:: com :: sun :: star :: text ::
service DocumentIndex
Description specifies service of content indexes within a document. See also BaseIndex

Included Services
BaseIndex | specifies the basic service of different indexes within a document.

Properties' Summary
UseAlphabeticalSeparators | [ OPTIONAL ] determins if alphabetical separators are genererated.
UseKeyAsEntry | [ OPTIONAL ] determins if a index entry is generated for each primary/secondary key.
UseCombinedEntries | [ OPTIONAL ] determins if same entries on different pages are combined into one index entry.
IsCaseSensitive | [ OPTIONAL ] determins if the similarity of index entries is checked case sensitively.
UsePP | [ OPTIONAL ] determins if following page numbers are displayed using a 'pp.'.
UseDash | [ OPTIONAL ] determins if if following page numbers are displayed using a dash.
UseUpperCase | [ OPTIONAL ] determins if all entries start with a capital letter.
MainEntryCharacterStyleName | [ OPTIONAL ] determins the name of the character style that is applied to the number of a page where main index entry is located.
DocumentIndexMarks | contains all index marks that are related to this index.
Locale | contains the locale of the index.
SortAlgorithm | contains the name of the sort algorithm that is used to sort the entries.

Properties' Details
UseAlphabeticalSeparators
boolean UseAlphabeticalSeparators; [ OPTIONAL ] Description determins if alphabetical separators are genererated.
UseKeyAsEntry
boolean UseKeyAsEntry; [ OPTIONAL ] Description determins if a index entry is generated for each primary/secondary key.
UseCombinedEntries
boolean UseCombinedEntries; [ OPTIONAL ] Description determins if same entries on different pages are combined into one index entry.
IsCaseSensitive
boolean IsCaseSensitive; [ OPTIONAL ] Description determins if the similarity of index entries is checked case sensitively.
UsePP
boolean UsePP; [ OPTIONAL ] Description determins if following page numbers are displayed using a 'pp.'.
UseDash
boolean UseDash; [ OPTIONAL ] Description determins if if following page numbers are displayed using a dash.
UseUpperCase
boolean UseUpperCase; [ OPTIONAL ] Description determins if all entries start with a capital letter.
MainEntryCharacterStyleName
string MainEntryCharacterStyleName; [ 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

Copyright © 2003 Sun Microsystems, Inc.