FormComponent Service Reference

specifies a component which can be part of a form. More...

import"FormComponent.idl";

Inheritance diagram for FormComponent:

Exported Interfaces
interface	com::sun::star::form::XFormComponent
	identifies the component as a candidate for being part of a form. More...
interface	com::sun::star::lang::XComponent
	allows life-time control of form components. More...
interface	com::sun::star::container::XNamed
	Each FormComponent must supply a name for identification. More...
interface	com::sun::star::beans::XPropertySet
	gives access to the properties. More...
interface	com::sun::star::io::XPersistObject
	Each FormComponent must be able to be stored into and read from a stream. More...
interface	com::sun::star::beans::XPropertyBag
	allows to associate arbitrary properties with the form component More...
Exported Interfaces inherited from XPropertyBag
interface	com::sun::star::beans::XPropertySet
interface	com::sun::star::beans::XPropertyContainer
interface	com::sun::star::beans::XPropertyAccess

Public Attributes
string	Name
	the name of the component. More...

Additional Inherited Members
Public Member Functions inherited from XChild
com::sun::star::uno::XInterface	getParent ()
	grants access to the object containing this content. More...
void	setParent ([in] com::sun::star::uno::XInterface Parent) raises ( com::sun::star::lang::NoSupportException )
	sets the parent to this object. More...
Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...
void	acquire ()
	increases the reference counter by one. More...
void	release ()
	decreases the reference counter by one. More...
Public Member Functions inherited from XComponent
void	dispose ()
	The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
void	addEventListener ([in] XEventListener xListener)
	adds an event listener to the object. More...
void	removeEventListener ([in] XEventListener aListener)
	removes an event listener from the listener list. More...
Public Member Functions inherited from XNamed
string	getName ()
void	setName ([in] string aName)
	sets the programmatic name of the object. More...
Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()
void	setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the value of the property with the specified name. More...
any	getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
void	addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XPropertyChangeListener to the specified property. More...
void	removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XPropertyChangeListener from the listener list. More...
void	addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
void	removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XVetoableChangeListener from the listener list. More...
Public Member Functions inherited from XPersistObject
string	getServiceName ()
	gives the service name of the object More...
void	write ([in] com::sun::star::io::XObjectOutputStream OutStream) raises ( com::sun::star::io::IOException )
	writes all the persistent data of the object to the stream. More...
void	read ([in] com::sun::star::io::XObjectInputStream InStream) raises ( com::sun::star::io::IOException )
	reads all the persistent data of the object from the stream. More...
Protected Member Functions inherited from XPropertyContainer
void	addProperty ([in] string Name, [in] short Attributes, [in] any DefaultValue) raises ( com::sun::star::beans::PropertyExistException, com::sun::star::beans::IllegalTypeException, com::sun::star::lang::IllegalArgumentException )
	adds a property to the object. More...
void	removeProperty ([in] string Name) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::NotRemoveableException )
	removes a property from the object. More...
Protected Member Functions inherited from XPropertyAccess
sequence< com::sun::star::beans::PropertyValue >	getPropertyValues ()
void	setPropertyValues ([in] sequence< com::sun::star::beans::PropertyValue > aProps) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the values of given properties. More...

Detailed 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

Exported Interfaces

com::sun::star::beans::XPropertyBag

interface com::sun::star::beans::XPropertyBag

optional

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, removable. That is, the com::sun::star::beans::PropertyAttribute::REMOVABLE will always be set, even if you do not specify it in the com::sun::star::beans::XPropertyContainer::addProperty() call.

Since

OOo 2.3

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

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

gives access to the properties.

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

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

Each FormComponent must supply a name for identification.

com::sun::star::form::XFormComponent

interface com::sun::star::form::XFormComponent

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::io::XPersistObject

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

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

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

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

allows life-time control of form components.

Member Data Documentation

Name

string Name

property

the name of the component.

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

---

The documentation for this service was generated from the following file:

• com/sun/star/form/FormComponent.idl