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

(Global Index)

Syntax

service DocumentIndexMark;

Description

is a TextRange which is explicitly marked as an index entry for a DocumentIndex .

Included Services

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

Description

is an object which can be anchored in a text, like instances of TextFrame or TextFields .


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

Description

is a TextRange which is explicitly marked as an index entry. This is the base service of index marks for DocumentIndex , ContentIndex , and UserIndex .


Property Summary

PrimaryKey contains the primary key of the index entry. It is used to build a hierarchical document index.

SecondaryKey contains the secondary key of the index entry. It is used to build a hierarchical document index.

IsMainEntry determins if this entry is a main entry. In a document index this entry will be emphasized by assigning a character style to it.

Property Details



PrimaryKey

Syntax

string PrimaryKey;

Description

contains the primary key of the index entry. It is used to build a hierarchical document index.


SecondaryKey

Syntax

string SecondaryKey;

Description

contains the secondary key of the index entry. It is used to build a hierarchical document index.


IsMainEntry

Syntax

boolean IsMainEntry;

Description

determins if this entry is a main entry. In a document index this entry will be emphasized by assigning a character style to it.

Top of Page