Interface XDocumentIndexMark

Attributes' Summary

Attributes' Details

interface XDocumentIndexMark

Base Interfaces

XDocumentIndexMark
┗ XTextContent
   ┗ ::com::sun::star::lang::XComponent

XTextContent

(referenced interface's summary:): enables objects to be inserted into a text and to provide their location in a text once they are inserted into it.

Description: gives access to the mark of a document index entry.
See also: DocumentIndexMark

Developers Guide: Text - Indexes and Index Marks - Index marks

Methods' Summary
getMarkEntry
setMarkEntry	sets an explicit string for this index mark to use in the index.

Methods' Details

getMarkEntry

string
getMarkEntry();

Returns: the explicitly set string for the index mark.
See also: setMarkEntry

setMarkEntry

void
setMarkEntry(	[in] string	aIndexEntry );

Description: sets an explicit string for this index mark to use in the index.; If empty, the string of the TextRange to which the TextContent refers is used in the index.

Top of Page

Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.