Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: view ::

unpublished interface XFormLayerAccess
Base Interfaces
XFormLayerAccessXControlAccess

XControlAccess
Description
provides access to form controls contained in the view
Usage Restrictions
not published
Description
provides access to the form layer elements in a view
Since
OOo 2.3

Methods' Summary
getFormController returns the ::com::sun::star::form::FormController instance which operates on a given form.  
isFormDesignMode determines whether the view's form layer is currently in design or alive mode  
setFormDesignMode determines whether the view's form layer is currently in design or alive mode  
Methods' Details
getFormController
::com::sun::star::form::runtime::XFormController
getFormController( [in] ::com::sun::star::form::XForm  Form );

Description
returns the ::com::sun::star::form::FormController instance which operates on a given form.

A form controller is a component which controls the user interaction with the form layer, as long as the form is not in design mode.

Returns
the requested form controller, or NULL if the view's form layer is currently in design mode. Note that the returned instance becomes non-functional as soon as the form layer is switched to design mode.
See also
isDesignMode, setDesignMode, ::com::sun::star::form::runtime::FormController, ::com::sun::star::form::runtime::FormOperations
isFormDesignMode
boolean
isFormDesignMode();

Description
determines whether the view's form layer is currently in design or alive mode

Note: This is a convenience method. In the user interface, the design mode is coupled with the .uno:SwitchControlDesignMode feature (see ::com::sun::star::frame::XDispatchProvider), and asking for the current mode is the same as asking for the state of this feature.

setFormDesignMode
void
setFormDesignMode( [in] boolean  DesignMode );

Description
determines whether the view's form layer is currently in design or alive mode

Note: This is a convenience method. In the user interface, the design mode is coupled with the .uno:SwitchControlDesignMode feature (see ::com::sun::star::frame::XDispatchProvider), and changing the current mode is the same as dispatching this feature URL.

Top of Page

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.