Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

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

service DataAwareControlModel

Description
is an abstract service for specialized FormControlModel s which are data aware and thus can be bound to a data source.


Included Services

com::sun::star::form::FormControlModel
Description
specifies a control model within a form.

Exported Interfaces

com::sun::star::form::XBoundComponent
[ OPTIONAL ]
Description
makes it possible to transfer The data of the model to the connected data field.
This interface is optional, if a component doesn't support it, it has to forward the changes of it's value to the field it is connected to immediately.
com::sun::star::form::XLoadListener
Description
must be implemented in order to recognize when the containing form of the model connects to its data source (loads its data). After loading the form, the model may bind to its related field source.
com::sun::star::form::XReset
Description
Each DataAwareControlModel should be resettable for setting default values. In general the XReset interface is used before a user starts editing a new record to set the desired default values for the model.

Properties' Summary

DataField specifies the name of the bound database field.
BoundField references to the cursor field to which the control is bound. Applies only if the form, the control model belongs to (the models parent), is loaded and the control is valid bound. The referenced field supports the Column service.
LabelControl references to a control model within the same document which should be used as a label.

Properties' Details

DataField
 
string DataField;
Description
specifies the name of the bound database field.
BoundField
 
[ readonly ] com::sun::star::beans::XPropertySet BoundField;
Description
references to the cursor field to which the control is bound. Applies only if the form, the control model belongs to (the models parent), is loaded and the control is valid bound. The referenced field supports the Column service.
LabelControl
 
com::sun::star::beans::XPropertySet LabelControl;
Description
references to a control model within the same document which should be used as a label.

Any user interface action which needs to refer to the control is assumed to use this property.
When setting this property a number of constraints apply: the object which is to be set has to support the XControlModel , XServiceInfo , XPropertySet and XChild interfaces. It has to be a part of the same document as the model who's property is to be modified. Additionally the support of a special service, indicating that the model is of the right type, is required. Which kind of service is in the request depends on the type of the control model.


Top of Page