service DataForm in module com::sun::star::form::component::

(Global Index)

Syntax

service DataForm;

Description

This service specifies a form which is connected to a database and displays the results of SQL queries. It provides the possiblity of adding new data records, modifying existing ones, or deleting them.

A database form is a special kind of enhanced database row set which provides all information for displaying the data and has more possibilities for configuring the data manipulation.

Included Services

com::sun::star::form::component::Form

com::sun::star::sdb::RowSet

Exported Interfaces

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

Description

is used to initialize a data row which should be inserted.


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

Description

used to load/unload the form

Loading a form is basically the same as executing the underlying row set. In fact, all the functionality of this interface could be simulated by using setting some properties manually, XRowSet::execute , moving the row set cursor and so on.

One main difference between XLoadable::load and XRowSet::execute is that if you use the former, the row set is positioned on the first record, while in the latter case it is position before the it.


Property Summary

MasterFields is used for subforms and contains the names of columns of the parent form.

DetailFields is used for subforms and contains the names of the columns of the subform which are related to the master fields of the parent form.

Cycle returns the kind of tabulator controlling.

NavigationBarMode How to use a NavigationBar?

AllowInserts Are insertions of new records allowed?

AllowUpdates Are modifications of the current record allowed?

AllowDeletes Are deletions of records allowed?

Property Details



MasterFields

Syntax

sequence< string > MasterFields;

Description

is used for subforms and contains the names of columns of the parent form.

These columns are typically the foreign key fields of the parent form. The values of theses columns are used to identify the data for the subform. Each time the parent form changes it's current row, the subform requeries it's data based on the values of the master fields.


DetailFields

Syntax

sequence< string > DetailFields;

Description

is used for subforms and contains the names of the columns of the subform which are related to the master fields of the parent form.

These columns represent typically a part of the primary key fields or their aliases of the detail form and are used as parameters in a database query to retrieve the details for an according master form.


Cycle

Syntax

com::sun::star::form::TabulatorCycle Cycle;

Description

returns the kind of tabulator controlling.


NavigationBarMode

Syntax

com::sun::star::form::NavigationBarMode NavigationBarMode;

Description

How to use a NavigationBar?


AllowInserts

Syntax

boolean AllowInserts;

Description

Are insertions of new records allowed?


AllowUpdates

Syntax

boolean AllowUpdates;

Description

Are modifications of the current record allowed?


AllowDeletes

Syntax

boolean AllowDeletes;

Description

Are deletions of records allowed?

Top of Page