:: com :: sun :: star :: ui :: dialogs ::

interface XControlInformation

Methods' Summary
getSupportedControls Query for the supported controls of a service instance.  
isControlSupported Returns whether the specified control is supported or not.  
getSupportedControlProperties Returns a sequence with properties supported by the specified control.  
isControlPropertySupported Returns whether control property is supported by a control.  
Methods' Details
getSupportedControls
sequence< string >
getSupportedControls();

Description
Query for the supported controls of a service instance.
Returns
a sequence with the names of the supported controls.
isControlSupported
boolean
isControlSupported( [in] string  aControlName );

Description
Returns whether the specified control is supported or not.
Parameter aControlName
The name of the control. Common control names are for instance "OkButton" or "CancelButton".
Returns
`TRUE` if the specified control is supported. `FALSE` if the specified control is not supported.
getSupportedControlProperties
sequence< string >
getSupportedControlProperties( [in] string  aControlName )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Returns a sequence with properties supported by the specified control.
Parameter aControlName
The name of the control. Common control names are for instance "OkButton" or "CancelButton".
Returns
a sequence of control properties supported by the specified control.
Throws
com::sun::star::lang::IllegalArgumentException when the specified control is not supported.
isControlPropertySupported
boolean
isControlPropertySupported( [in] string  aControlName,
[in] string  aControlProperty )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Returns whether control property is supported by a control.
Parameter aControlName
The name of the control.
Parameter aControlProperty
The control property to query for.
Returns
`TRUE` if the specified control action is supported. `FALSE` if the specified control action is not supported.
Throws
com::sun::star::lang::IllegalArgumentException when the specified control is not supported.
Top of Page