Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XControlInformation
Description
Interface to query for controls and control properties supported by the implementing instance.
Since
OOo 1.1.2

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

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.