Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: accessibility ::

interface XAccessibleTextAttributes
Description
Implement this interface to give access to the attributes of a text.
Since
OOo 2.0.4

Methods' Summary
getDefaultAttributes Get the default attribute set for the text.  
getRunAttributes Get the run attribute set for the specified position.  
Methods' Details
getDefaultAttributes
sequence< ::com::sun::star::beans::PropertyValue >
getDefaultAttributes( [in] sequence< string >  RequestedAttributes );

Description
Get the default attribute set for the text.

Returns a set of all default paragraph and default character attributes that are associated for the text. To prevent the method from returning possibly large sets of attributes that the caller is not interested in the caller can provide a list of attributes that he wants to be returned.

Parameter RequestedAttributes
This string sequence defines the set of attributes that the caller is interested in. When there are requested attributes that are not defined for the text then they are ignored.

When the sequence is empty all attributes are returned.

Returns
Returns the requested attributes of the text. Each attribute is represented by a ::com::sun::star::beans::PropertyValue object.
getRunAttributes
sequence< ::com::sun::star::beans::PropertyValue >
getRunAttributes( [in] long  Index,
[in] sequence< string >  RequestedAttributes )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
Get the run attribute set for the specified position.

Returns a set of character attributes that are associated for the character at the given index and are directly set or are set via a character style. To prevent the method from returning all of these attributes the caller can provide a list of attributes that he wants to be returned.

Parameter Index
The index of the character for which to return its attributes. The valid range is 0..length of text-1.
Parameter RequestedAttributes
This string sequence defines the set of attributes that the caller is interested in. When there are requested attributes that are not defined for the text then they are ignored.

When the sequence is empty all attributes are returned.

Returns
Returns the requested attributes of the specified character. Each attribute is represented by a ::com::sun::star::beans::PropertyValue object.
Throws
::com::sun::star::lang::IndexOutOfBoundsException if the index is invalid
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

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