Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

interface XControlAccess
Description
Generic control access interface.

Use this interface to access user interface controls supported by the implementing service. The supported controls, control properties and the appropriate values are documented in the decription of the implementing service.

Since
OOo 1.1.2
See also
FilePicker, FilePicker
Methods' Summary
setControlProperty Change a control property.  
getControlProperty Query for a control property.  
Methods' Details
setControlProperty
void
setControlProperty( [in] string  aControlName,
[in] string  aControlProperty,
[in] any  aValue )
raises( ::com::sun::star::lang::IllegalArgumentException );
Description
Change a control property.
Parameter aControlName
The name of the control. Common control names are for instance 'OkButton' or 'CancelButton'.
Parameter aControlProperty
The control property to manipulate. Common control properties are for instance 'Label' or 'State'.
Parameter aValue
A value appropriated for the property.
Throws
com::sun::star::lang::IllegalArgumentException when the control is not supported, the control property is invalid or the value fits not the control action.
getControlProperty
any
getControlProperty( [in] string  aControlName,
[in] string  aControlProperty )
raises( ::com::sun::star::lang::IllegalArgumentException );
Description
Query for a control property.
Parameter aControlName
The name of the control. Common control names are for instance 'OkButton' or 'CancelButton'.
Parameter aControlProperty
The requested control property. Common control properties are for instance 'Label' or 'State'.
Returns
the requested value.
Throws
com::sun::star::lang::IllegalArgumentException when the control is not supported or the control property is invalid.
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

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

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