LibreOffice
LibreOffice 24.2 SDK API Reference
Public Member Functions | List of all members
XFastPropertySet Interface Referencepublished

provides a fast way of accessing and changing property values. More...

import"XFastPropertySet.idl";

Inheritance diagram for XFastPropertySet:
XInterface PropertySet XDrawSubController FormControlModel PropertyBrowserController Quickstart XTable Axis DataPointProperties DataSeries DataTable Legend RegressionCurve RegressionCurveEquation Title FormulaParser BindableControlModel CheckBox ComboBox CommandButton CurrencyField DateField FileControl FixedText FormattedField GridControl GroupBox ImageButton ListBox NavigationToolBar NumericField PatternField RadioButton RichTextControl ScrollBar SpinButton SubmitButton TextField TimeField DataAwareControlModel ValidatableControlModel

Public Member Functions

void setFastPropertyValue ([in] long nHandle, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value to the property with the specified name. More...
 
any getFastPropertyValue ([in] long nHandle) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
- 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 a fast way of accessing and changing property values.

This interface is an extension to the XPropertySet interface. The get and set methods use handles to access the property values instead of character strings.

Developers Guide
Professional UNO - Properties

Member Function Documentation

◆ getFastPropertyValue()

any getFastPropertyValue ( [in] long  nHandle)
raises ( com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException
)
Returns
the value of the property with the name PropertyName.
Parameters
nHandlecontains the implementation handle of the implementation for the property.
Exceptions
UnknownPropertyExceptionif the property does not exist.
com::sun::star::lang::WrappedTargetExceptionif the implementation has an internal reason for the exception. In this case the original exception is wrapped into that com::sun::star::lang::WrappedTargetException.

◆ setFastPropertyValue()

sets the value to the property with the specified name.

Parameters
nHandlecontains the implementation handle of the implementation for the property.
aValuecontains the new value of the property.
Exceptions
UnknownPropertyExceptionif the property does not exist.
PropertyVetoExceptionif a vetoable listener does not approve the change of a property value.
IllegalArgumentExceptionif the new value cannot be converted to the type of the underlying property by an identity or widening conversion.
com::sun::star::lang::WrappedTargetExceptionif the implementation has an internal reason for the exception. In this case the original exception is wrapped into this com::sun::star::lang::WrappedTargetException.

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