service DocumentIndex in module com::sun::star::text::

(Global Index)

Syntax

service DocumentIndex;

Description

specifies service of content indexes within a document.

See also

BaseIndex

Included Services

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

Description

specifies the basic service of different indexes within a document.


Property Summary

UseAlphabeticalSeparators

UseKeyAsEntry

UseCombinedEntries

IsCaseSensitive

UsePP

UseDash

UseUpperCase

MainEntryCharacterStyleName

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.

Property Details



UseAlphabeticalSeparators [ O P T I O N A L ]

Syntax

boolean UseAlphabeticalSeparators;

UseKeyAsEntry [ O P T I O N A L ]

Syntax

boolean UseKeyAsEntry;

UseCombinedEntries [ O P T I O N A L ]

Syntax

boolean UseCombinedEntries;

IsCaseSensitive [ O P T I O N A L ]

Syntax

boolean IsCaseSensitive;

UsePP [ O P T I O N A L ]

Syntax

boolean UsePP;

UseDash [ O P T I O N A L ]

Syntax

boolean UseDash;

UseUpperCase [ O P T I O N A L ]

Syntax

boolean UseUpperCase;

MainEntryCharacterStyleName [ O P T I O N A L ]

Syntax

string MainEntryCharacterStyleName;

DocumentIndexMarks

Syntax

[readonly] sequence< com::sun::star::text::XDocumentIndexMark > DocumentIndexMarks;

Description

contains all index marks that are related to this index.


Locale

Syntax

com::sun::star::lang::Locale Locale;

Description

contains the locale of the index.


SortAlgorithm

Syntax

string SortAlgorithm;

Description

contains the name of the sort algorithm that is used to sort the entries.

Top of Page