(incubating) | The Free and Open Productivity Suite
Announcing Apache OpenOffice 3.4

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
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 © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache Feather

Copyright & License | Privacy | Contact Us

Apache and the Apache feather logos are trademarks of The Apache Software Foundation. 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.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.