LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XAccessibleTextAttributes Interface Reference

Implement this interface to give access to the attributes of a text. More...

import"XAccessibleTextAttributes.idl";

Inheritance diagram for XAccessibleTextAttributes:
AccessibleParagraphView

Public Member Functions

sequence<::com::sun::star::beans::PropertyValuegetDefaultAttributes ([in] sequence< string > RequestedAttributes) raises ( ::com::sun::star::beans::UnknownPropertyException )
 Get the default attribute set for the text. More...
 
sequence<::com::sun::star::beans::PropertyValuegetRunAttributes ([in] long Index, [in] sequence< string > RequestedAttributes) raises (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::IndexOutOfBoundsException)
 Get the run attribute set for the specified position. More...
 

Detailed Description

Implement this interface to give access to the attributes of a text.

Since
OOo 2.0.4

Member Function Documentation

sequence<::com::sun::star::beans::PropertyValue> getDefaultAttributes ( [in] sequence< string >  RequestedAttributes)
raises (::com::sun::star::beans::UnknownPropertyException
)

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.

Parameters
RequestedAttributesThis 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.
sequence<::com::sun::star::beans::PropertyValue> getRunAttributes ( [in] long  Index,
[in] sequence< string >  RequestedAttributes 
)
raises (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::IndexOutOfBoundsException
)

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.

Parameters
IndexThe index of the character for which to return its attributes. The valid range is 0..length of text-1.
RequestedAttributesThis 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.
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif the index is invalid

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