service GridControl in module com::sun::star::form::control::

(Global Index)

Syntax

service GridControl;

Description

describes a table-like control for displaying data.

The control is usually used together with a model implementing the GridControl service.

Included Services

com::sun::star::awt::UnoControl

Exported Interfaces

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

Description

allows committing the content of the active cell of the control.


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

Description

allows access to the active cell within the grid.

Only the column position can be modified using this interface, as the row position within a table control bound to a data source is given implicitly (by the cursor position of the data source).


com::sun::star::util::XModifyBroadcaster

Description

used to broadcast modifications made by the user (within the active cell)


com::sun::star::form::XGridFieldDataSupplier [ OPTIONAL ]

Description

allows access to the field data of the grid's current row in different formats


com::sun::star::container::XIndexAccess

Description

allows access to objects wrapping a single column


com::sun::star::container::XEnumerationAccess

Description

allows creation of an enumeration for the column objects


com::sun::star::container::XContainer

Description

allows to add/remove listeners.


com::sun::star::util::XModeSelector [ OPTIONAL ]

Description

is used to switch the operating modes of the control.

Besides the normal opreration mode (which is used to display the database form's data) the control may for instance support a filter mode.


com::sun::star::view::XSelectionSupplier [ OPTIONAL ]

Description

used to control the selection of rows in the grid control.

The selection used with the methods XSelectionSupplier::getSelection and XSelectionSupplier::select is a sequence of Any's.
Here the elements of the Sequence are the bookmarks (in the RowSet ) of the (to-be-) selected rows.


com::sun::star::frame::XDispatchProviderInterception [ OPTIONAL ]

Description

allows external components to register dispatchers for some common form actions.

A grid control can contain own UI elements for traveling within the database form it belongs to (This concept seems to make sense, as a grid control - in opposite to other data aware controls - displayes not only one record at a time, but a larger number of records of the database form.)
With the help of this interface, external components which wish to handle such travelings themself can register interceptors for the actions in question.

Usual URLs to use include

  • .uno:FormSlots/moveToFirst : move the cursor to the first record
  • .uno:FormSlots/moveToPrev : move the cursor to the previous record
  • .uno:FormSlots/moveToNext : move the cursor to the next record
  • .uno:FormSlots/moveToLast : move the cursor to the last record
  • .uno:FormSlots/moveToNew : move the cursor to the (one and only) new record
  • .uno:FormSlots/undoRecord : undo the changes done so far in the current record

A concrete implementation of this service may offer more or less URLs, but if it offers some of the URLs above, it must stick to the meanings defined above.


Top of Page