Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: script ::
interface XInvocation
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XInvocation
Description 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 .

Methods' Summary
getIntrospection | returns the introspection from this object or NULL if the object does not provide this information.
invoke | provides access to methods exposed by an object.
setValue | sets a value to the property with the specified name.
getValue | returns the value of the property with the specified name.
hasMethod | returns true if the method with the specified name exists, else false .
hasProperty | returns true if the property with the specified name exists, else false .

Methods' Details
getIntrospection
::com::sun::star::beans::XIntrospectionAccess getIntrospection(); |  |
Description returns the introspection from this object or NULL if the object does not provide this information.
invoke
any invoke( | [in] string [in] sequence< any > [out] sequence< short > [out] sequence< any > raises( | aFunctionName, aParams, aOutParamIndex, aOutParam ) ::com::sun::star::lang::IllegalArgumentException, CannotConvertException, ::com::sun::star::reflection::InvocationTargetException );
Description provides access to methods exposed by an object. Parameter aParams all parameters; pure out params are undefined in sequence, the value has to be ignored by the callee Parameter aOutParamIndex This sequence contains the indices of all parameters that are specified as out or inout. Parameter 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.
setValue
void setValue( | [in] string [in] any raises( | aPropertyName, aValue ) ::com::sun::star::beans::UnknownPropertyException, CannotConvertException, ::com::sun::star::reflection::InvocationTargetException );
Description 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 .
getValue
any getValue( | [in] string raises( | aPropertyName ) ::com::sun::star::beans::UnknownPropertyException );
Description returns the value of the property with the specified name. Parameter aPropertyName specifies the name of the property.
hasMethod
boolean hasMethod( | [in] string | aName );
Description returns true if the method with the specified name exists, else false . This optimizes the calling sequence ( XInvocation::hasMethod , XInvocation::invoke )! Parameter aName specifies the name of the method.
hasProperty
boolean hasProperty( | [in] string | aName );
Description returns true if the property with the specified name exists, else false . 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

Copyright © 2003 Sun Microsystems, Inc.