Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: accessibility ::
unpublished | interface XAccessibleTextMarkup |
  Base Interfaces
      XAccessibleTextMarkup
      ┗ XAccessibleText
  XAccessibleText | (referenced interface's summary:) 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. Since OOo 3.0 See also XAccessibleText

Methods' Summary
getTextMarkupCount | Returns the number of text markup of the given text markup type of a text.
getTextMarkup | Returns the text segment of the text markup of the given index and of the given text mark type
getTextMarkupAtIndex | returns a sequence of the text segments of the text markups at the given character index and of the given text markup type.

Methods' Details
getTextMarkupCount
long
getTextMarkupCount( | [in] long | TextMarkupType )
raises( | ::com::sun::star::lang::IllegalArgumentException );
Description Returns the number of text markup of the given text markup type of a text. Throws ::IllegalArgumentException, if given text markup type is out of valid range. Parameter TextMarkupType This specifies the type of text markups, whose count should be returned - see ::TextMarkupType. Returns The number of text markup of the given text markup type. Returns 0 if there is no text markup.
getTextMarkup
TextSegment
getTextMarkup( | [in] long | TextMarkupIndex,
| [in] long | TextMarkupType )
raises( | ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException );
Description 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.
getTextMarkupAtIndex
sequence< TextSegment >
getTextMarkupAtIndex( | [in] long | CharIndex,
| [in] long | TextMarkupType )
raises( | ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException );
Description 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 sequence 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.

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.