Implement this interface to give read-only access to a text.
Usage Restrictions
not published
Description
Implement this interface to expose the text markups of a text.
The XAccessibleTextMarkup interface is the main interface
to expose text markups in a text, typically of a text document, that are
used to reference other (parts of) documents. For supporting the
getTextMarkupIndex method of this
interface and other character related methods of the
XAccessibleTextMarkup interface, it is necessary to also
support the XAccessibleText interface.
Returns the text segment of the text markup of the given index and
of the given text mark type
Throws ::IndexOutOfBoundsException, if given index
is out of valid range.
Throws ::IllegalArgumentException, if given text
markup type is out of valid range.
Parameter TextMarkupIndex
This index specifies the text markup to return.
Parameter TextMarkupType
This specifies the type of the text markup to be returned - see
::TextMarkupType.
Returns
If the given index is in range [0..getTextMarkupCount(TextMarkupType)-1],
the text segment - see TextSegment - of the text markup
of the given text markup type is returned.
returns a sequence of the text segments of the text markups at the given
character index and of the given text markup type.
Throws ::IndexOutOfBoundsException, if given character
index is out of range [0..number of characters in the text).
Throws ::IllegalArgumentException, if given text
markup type is out of valid range.
Parameter CharIndex
This index specifies the character index in the text.
Parameter TextMarkupType
This specifies the type of the text markups to be returned - see
::TextMarkupType.
Returns
If character index is in range [0..number of characters in the text-1],
a seguence of TextSegments of the text markups at
given character index of the given text markup type are returned.
The sequence is empty, if no such text markup is found.