LibreOffice
LibreOffice 5.3 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
XTolerantMultiPropertySet Interface Referencepublished

provides access to multiple iformation of a set of properties with a single call. More...

import "XTolerantMultiPropertySet.idl";

Inheritance diagram for XTolerantMultiPropertySet:
XInterface Shape SheetCell SheetCellRange Paragraph TextPortion ChartLegend ChartTitle AppletShape CaptionShape ClosedBezierShape ConnectorShape ControlShape CustomShape EllipseShape GraphicObjectShape GroupShape LineShape MeasureShape OLE2Shape OpenBezierShape PageShape PluginShape PolyLineShape PolyPolygonBezierShape PolyPolygonShape RectangleShape TextShape Shape Shape SheetCellCursor Spreadsheet RedlinePortion

Public Member Functions

sequence
< com::sun::star::beans::SetPropertyTolerantFailed
setPropertyValuesTolerant ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::lang::IllegalArgumentException )
 sets the values to the properties with the specified names. More...
 
sequence
< com::sun::star::beans::GetPropertyTolerantResult
getPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve the values of the specified properties More...
 
sequence
< com::sun::star::beans::GetDirectPropertyTolerantResult
getDirectPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve only those values of the specified properties which are direct values. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

provides access to multiple iformation of a set of properties with a single call.

The speciality of this interface is that none of the functions will throw the usual exceptions associated with setting and retrieving of property values. Instead the data for the failures is collected and returned.

Note: There is no support for property change listeners in this interface.

See Also
com::sun::star::beans::XPropertySet
com::sun::star::beans::XMultiPropertySet

Member Function Documentation

sequence< com::sun::star::beans::GetDirectPropertyTolerantResult > getDirectPropertyValuesTolerant ( [in] sequence< string >  aPropertyNames)

retrieve only those values of the specified properties which are direct values.

Since the count of returned elements may be different from the number of supplied property names the returned elements will also state the name of the property.

Parameters
aPropertyNamesspecifies the names of the properties. The property names must be sorted ascending.

If the names are not sorted the behaviour of the method is undefined!

Returns
a sequence of type com::sun::star::beans::GetDirectPropertyTolerantResult but only for those properties supplied whoms state is com::sun::star::beans::PropertyState::DIRECT_VALUE.
sequence< com::sun::star::beans::GetPropertyTolerantResult > getPropertyValuesTolerant ( [in] sequence< string >  aPropertyNames)

retrieve the values of the specified properties

The count and order of the values in the returned sequence will be the same as the order of the names in the argument.

Parameters
aPropertyNamesspecifies the names of the properties. The property names must be sorted ascending.

If the names are not sorted the behaviour of the method is undefined!

Returns
a sequence of type com::sun::star::beans::GetPropertyTolerantResult for each of the properties listed in aPropertyNames.
sequence< com::sun::star::beans::SetPropertyTolerantFailed > setPropertyValuesTolerant ( [in] sequence< string >  aPropertyNames,
[in] sequence< any >  aValues 
)
raises (com::sun::star::lang::IllegalArgumentException
)

sets the values to the properties with the specified names.

Parameters
aPropertyNamesspecifies the names of the properties. The property names must be sorted ascending.

If the names are not sorted the behaviour of the method is undefined!

Parameters
aValuesspecifies the values of the properties. The order of the values has to be the same as in the aPropertyNames parameter int order to match the property name with its value.
Returns
An empty sequence if all properties are successful set.

Otherwise for every property value that could not successfully be set an entry of the com::sun::star::beans::SetPropertyTolerantFailed will be present in this sequence. The order of the properties is also alphabetically ascending.

Exceptions
IllegalArgumentExceptionif the number of property names and values do not match.

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