Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.3 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

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

Included Services - Summary
TextContent
(referenced entity's summary:)
is an object which can be anchored in a text, like instances of TextFrame or TextField.
BaseIndexMark
(referenced entity's summary:)
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
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.  
Included Services - Details
TextContent
(referenced entity's summary:)
is an object which can be anchored in a text, like instances of TextFrame or TextField.
BaseIndexMark
(referenced entity's summary:)
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' 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

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.