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 :: form ::

service FormComponent
Description
specifies a component which can be part of a form.
See also
FormControlModel, ::com::sun::star::form::component::Form
Developers Guide
Forms - Control Models

Included Services - Summary
::com::sun::star::beans::PropertyBag

allows to associate arbitrary properties with the form component (details)

Exported Interfaces - Summary
XFormComponent

identifies the component as a candidate for being part of a form. (details)

::com::sun::star::lang::XComponent

allows life-time control of form components.

::com::sun::star::container::XNamed

Each FormComponent must supply a name for identification.

::com::sun::star::beans::XPropertySet

gives access to the properties.

::com::sun::star::io::XPersistObject

Each FormComponent must be able to be stored into and read from a stream.

Properties' Summary
string
Name
the name of the component.  
Included Services - Details
::com::sun::star::beans::PropertyBag
Usage Restrictions
optional
Description
allows to associate arbitrary properties with the form component

Every concrete form component - i.e. every service which includes the FormComponent service - has a set of properties which are available as long as the component lives - the so-called static properties.

Additionally, you can add more properties to the component as needed, using the ::com::sun::star::beans::XPropertyContainer interface. Those properties are called dynamic properties.

Dynamic properties are not evaluated by the component itself, nor by the form's runtime environment. They're only remembered and available for use by other instances.

Note that dynamic properties added to a form component are, by definition, removeable. That is, the ::com::sun::star::beans::PropertyAttribute::REMOVEABLE will always be set, even if you do not specify it in the ::com::sun::star::beans::XPropertyContainer::addProperty call.

Since
OOo 2.3
Exported Interfaces - Details
XFormComponent
Description
identifies the component as a candidate for being part of a form.

This interface also provides the access to the component's parent.

::com::sun::star::lang::XComponent
Description
allows life-time control of form components.
::com::sun::star::container::XNamed
Description
Each FormComponent must supply a name for identification.
::com::sun::star::beans::XPropertySet
Description
gives access to the properties.
::com::sun::star::io::XPersistObject
Description
Each FormComponent must be able to be stored into and read from a stream.
Properties' Details
Name
string Name;
Description
the name of the component.

Note that the name accessed here is the same as when using the ::com::sun::star::container::XNamed interface.


 
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.