|
LibreOffice
LibreOffice 24.8 SDK API Reference
|
gives access to an object's methods and properties. More...
import "XInvocation.idl";
Public Member Functions | |
| com::sun::star::beans::XIntrospectionAccess | getIntrospection () |
| returns the introspection from this object or NULL if the object does not provide this information. | |
| any | invoke ([in] string aFunctionName, [in] sequence< any > aParams, [out] sequence< short > aOutParamIndex, [out] sequence< any > aOutParam) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::script::CannotConvertException, com::sun::star::reflection::InvocationTargetException ) |
| provides access to methods exposed by an object. | |
| void | setValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::script::CannotConvertException, com::sun::star::reflection::InvocationTargetException ) |
| sets a value to the property with the specified name. | |
| any | getValue ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
| returns the value of the property with the specified name. | |
| boolean | hasMethod ([in] string aName) |
| returns TRUE if the method with the specified name exists, else FALSE. | |
| boolean | hasProperty ([in] string aName) |
| returns TRUE if the property with the specified name exists, else FALSE. | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. | |
| void | acquire () |
| increases the reference counter by one. | |
| void | release () |
| decreases the reference counter by one. | |
gives access to an object's methods and properties.
Container access is available through com::sun::star::container::XIndexContainer, com::sun::star::container::XNameContainer and com::sun::star::container::XEnumerationAccess.
| com::sun::star::beans::XIntrospectionAccess getIntrospection | ( | ) |
returns the introspection from this object or NULL if the object does not provide this information.
| any getValue | ( | [in] string | aPropertyName | ) | ||
| raises | ( | com::sun::star::beans::UnknownPropertyException ) | ||||
returns the value of the property with the specified name.
| aPropertyName | specifies the name of the property. |
| boolean hasMethod | ( | [in] string | aName | ) |
returns TRUE if the method with the specified name exists, else FALSE.
This optimizes the calling sequence ( XInvocation::hasMethod(), XInvocation::invoke() )!
@param aName
specifies the name of the method.
| boolean hasProperty | ( | [in] string | aName | ) |
returns TRUE if the property with the specified name exists, else FALSE.
<p>This optimizes the calling sequence
( XInvocation::hasProperty(),
XInvocation::getValue() ) or
( XInvocation::hasProperty(),
XInvocation::setValue() )!
@param aName
specifies the name of the property.
| any invoke | ( | [in] string | aFunctionName, | |||
| [in] sequence< any > | aParams, | |||||
| [out] sequence< short > | aOutParamIndex, | |||||
| [out] sequence< any > | aOutParam ) | |||||
| raises | ( | com::sun::star::lang::IllegalArgumentException, | ||||
| com::sun::star::script::CannotConvertException, | ||||||
| com::sun::star::reflection::InvocationTargetException ) | ||||||
provides access to methods exposed by an object.
| aFunctionName | the method to invoke |
| aParams | all parameters; pure out params are undefined in sequence, the value has to be ignored by the callee |
| aOutParamIndex | This sequence contains the indices of all parameters that are specified as out or inout. |
| aOutParam | This sequence contains the values of all parameters that are specified as out or inout and corresponds with the indices provided by the aOutParamIndex sequence. |
Example: aOutParamIndex == { 1, 4 } means that aOutParam[0] contains the out value of the aParams[1] parameter and aOutParam[1] contains the out value of the aParams[4] parameter.
| void setValue | ( | [in] string | aPropertyName, | |||
| [in] any | aValue ) | |||||
| raises | ( | com::sun::star::beans::UnknownPropertyException, | ||||
| com::sun::star::script::CannotConvertException, | ||||||
| com::sun::star::reflection::InvocationTargetException ) | ||||||
sets a value to the property with the specified name.
If the underlying object implements an com::sun::star::container::XNameContainer, then this method will insert the value if there is no such aPropertyName.