Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: script ::

interface XInvocation

Base Interface
com::sun::star::uno::XInterface

Description
makes it possible to invoke methods and set/get properties at an object which corresponds with the object which implements this interface. Container access is available through XIndexContainer , XNameContainer and XEnumerationAccess .



Methods' Summary

getIntrospection
invoke provides access to properties and methods exposed by an object.
setValue sets a value to the property with the specified name.
getValue
hasMethod
hasProperty

Methods' Details

getIntrospection
 
com::sun::star::beans::XIntrospectionAccess
getIntrospection();
Returns
the introspection from this object or NULL if the object does not provide this information.
invoke
 
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 );

Description
provides access to properties and methods exposed by an object.
Parameter aParams
all parameters; pure, out params are undefined in sequence, i.e., the value has to be ignored by the callee
Parameter aOutParamIndex
out indices
Parameter aOutParam
out parameters
setValue
 
void
setValue(
[ in ] string aPropertyName,
[ in ] any aValue )
raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::script::CannotConvertException, com::sun::star::reflection::InvocationTargetException );

Description
sets a value to the property with the specified name.

If the underlying object implements an XNameContainer , then this method will insert the value if there is no such aPropertyName .

getValue
 
any
getValue(
[ in ] string aPropertyName )
raises ( com::sun::star::beans::UnknownPropertyException );

Returns
the value of the property with the specified name.
Parameter aPropertyName
specifies the name of the property.
hasMethod
 
boolean
hasMethod(
[ in ] string aName );

Returns
true if the method with the specified name exists.

This optimizes the calling sequence ( XInvocation::hasMethod , XInvocation::invoke )!

Parameter aName
specifies the name of the method.
hasProperty
 
boolean
hasProperty(
[ in ] string aName );

Returns
true if the property with the specified name exists.

This optimizes the calling sequence ( XInvocation::hasProperty , XInvocation::getValue ) or ( XInvocation::hasProperty , XInvocation::setValue )!

Parameter aName
specifies the name of the property.

Top of Page