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

Inheritance diagram for DocumentIndexMark:

Included Services
service	com::sun::star::text::TextContent

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

Included Services inherited from BaseIndexMark
service	com::sun::star::text::TextContent

Public Attributes
string	PrimaryKey
	contains the primary key of the index entry. More...

string	SecondaryKey
	contains the secondary key of the index entry. More...

boolean	IsMainEntry
	determines if this entry is a main entry. More...

Public Attributes inherited from TextContent
com::sun::star::text::TextContentAnchorType	AnchorType
	specifies how the text content is attached to its surrounding Text. More...

com::sun::star::text::WrapTextMode	TextWrap
	specifies if the text content is a shape and how the text is wrapped around the shape. More...

Public Attributes inherited from BaseIndexMark
string	AlternativeText
	the string that will be inserted into the corresponding index. More...

Additional Inherited Members
Public Types inherited from TextContent
typedef sequence< com::sun::star::text::TextContentAnchorType >	AnchorTypes
	contains the anchor type of the text content. More...

Exported Interfaces inherited from TextContent
interface	com::sun::star::text::XTextContent
	This interface is used for the attachment of this text content to the surrounding text. More...

Public Member Functions inherited from XTextContent
void	attach ([in] com::sun::star::text::XTextRange xTextRange) raises ( com::sun::star::lang::IllegalArgumentException )
	is called when this object gets embedded in a text. More...

com::sun::star::text::XTextRange	getAnchor ()

Public Member Functions inherited from XComponent
void	dispose ()
	The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...

void	addEventListener ([in] XEventListener xListener)
	adds an event listener to the object. More...

void	removeEventListener ([in] XEventListener aListener)
	removes an event listener from the listener list. More...

Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...

void	acquire ()
	increases the reference counter by one. More...

void	release ()
	decreases the reference counter by one. More...

Detailed Description

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

Exported Interfaces

boolean IsMainEntry

property

determines if this entry is a main entry.

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

string PrimaryKey

property

contains the primary key of the index entry.

It is used to build a hierarchical document index.

string SecondaryKey

property

contains the secondary key of the index entry.

It is used to build a hierarchical document index.

The documentation for this service was generated from the following file: