(incubating) | The Free and Open Productivity Suite
Announcing Apache OpenOffice 3.4

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Services' Summary Interfaces' Summary Properties' Summary Services' Details Interfaces' Details 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 - 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

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache Feather

Copyright & License | Privacy | Contact Us

Apache and the Apache feather logos are trademarks of The Apache Software Foundation. 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.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.