Overview Module Use Devguide Index
Included Services Exported Interfaces Properties' Summary Properties' Details

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

service DocumentIndexMark
Description
is a ::com::sun::star::text::TextRange which is explicitly marked as an index entry for a ::com::sun::star::text::DocumentIndex .
Included Services
::com::sun::star::text::TextContent
(referenced entity's summary:)
is an object which can be anchored in a text, like instances of ::com::sun::star::text::TextFrame or ::com::sun::star::text::TextFields .
::com::sun::star::text::BaseIndexMark
(referenced entity's summary:)
is a ::com::sun::star::text::TextRange which is explicitly marked as an index entry. This is the base service of index marks for ::com::sun::star::text::DocumentIndex , ::com::sun::star::text::ContentIndex , and ::com::sun::star::text::UserIndex .
Properties' Summary
string
PrimaryKey		 contains the primary key of the index entry. It is used to build a hierarchical document index.  
string
SecondaryKey		 contains the secondary key of the index entry. It is used to build a hierarchical document index.  
boolean
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

Copyright © 2003 Sun Microsystems, Inc.