This service provides access to the structure of the levels of document indexes.
The element type is Sequence< PropertyValues >. Each element in this sequence represents
a member of an index line. The following properties are part of such an element.
TokenType
Values:
TokenEntryNumber - chapter number, used in content indexes
only
TokenEntryText - text of the entry
TokenTabStop - tab stop
TokenText - user defined text
TokenPageNumber - page number
TokenChapterInfo - chapter info, in illustration indexes,
table indexes, user indexes, table of objects and alphabetical indexes
only
TokenHyperlinkStart - start of a hyperlink
TokenHyperlinkEnd - end of a hyperlink
TokenBibliographyDataField - bibliographic data field
CharacterStyleName
Name of the character style applied to the element. Invalid in tab stops.
TabStopRightAligned
Tab stop is right aligned. Only valid for tab stops.
TabStopPosition
Position of the tab stop. Only valid for tab stops.
TabStopFillCharacter
Fill character in tab stops. Only valid for tab stops.
WithTab
If true insert tab character.
Text
Text. Only valid in user defined text.
ChapterFormat
Valid in chapter info and entry number only. See ChapterFormat.
Other information.
In chapter info only com.sun.star.text.ChapterFormat.NUMBER, com.sun.star.text.ChapterFormat.NAME, and
com.sun.star.text.ChapterFormat.NAME_NUMBER constants are allowed.
In entry number only com.sun.star.text.ChapterFormat.NUMBER and com.sun.star.text.ChapterFormat.DIGIT constants are allowed.
ChapterLevel
Valid in chapter info and entry number only. Denotes the level up to which
the chapter information is given. Values permitted 1 to 10 inclusive.
