Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

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

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 .

Properties' 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.

Properties' Details

PrimaryKey
 
string PrimaryKey;
Description
contains the primary key of the index entry. It is used to build a hierarchical document index.
SecondaryKey
 
string SecondaryKey;
Description
contains the secondary key of the index entry. It is used to build a hierarchical document index.
IsMainEntry
 
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