LibreOffice: com::sun::star::form::runtime::FormFeature Constant Group Reference

LibreOffice LibreOffice 6.1 SDK API Reference

Variables
com::sun::star::form::runtime::FormFeature Constant Group Reference

specifies the operations on a user interface form, as supported by the XFormOperations interface. More...

## Variables
const short | MoveAbsolute = 1
| moves the form to a record given by absolute position. More...
const short | TotalRecords = 2
| determines the number of total records in the form, including the potentially active insertion row. More...
const short | MoveToFirst = 3
| moves the form to the first record More...
const short | MoveToPrevious = 4
| moves the form to the record before the current record, if there is any More...
const short | MoveToNext = 5
| moves the form to the record after the current record, if there is any More...
const short | MoveToLast = 6
| moves the form to the last record More...
const short | MoveToInsertRow = 7
| moves the form to the insertion row, if privileges allow More...
const short | SaveRecordChanges = 8
| saves all changes in the form's current record, including changes in the current control which had not yet been committed to the form More...
const short | UndoRecordChanges = 9
| reverts all changes in the form's current record, including changes in the current control which had not yet been committed to the form More...
const short | DeleteRecord = 10
| deletes the current record, while honoring any registered com::sun::star::form::XConfirmDeleteListeners More...
const short | ReloadForm = 11
| reloads the form content More...
const short | SortAscending = 12
| sorts the form ascending by the field which the active form control is bound to. More...
const short | SortDescending = 13
| sorts the form descending by the field which the active form control is bound to. More...
const short | InteractiveSort = 14
| opens a dialog which allows the user to interactively specify a form sorting order More...
const short | AutoFilter = 15
| adds a filter to the form, which is defined by the active form control and its current value More...
const short | InteractiveFilter = 16
| opens a dialog which allows the user to interactively specify a form filter More...
const short | ToggleApplyFilter = 17
| toggles the com::sun::star::sdb::RowSet::ApplyFilter property of a the form. More...
const short | RemoveFilterAndSort = 18
| removes all filter and sort criteria put on the form. More...
const short | RefreshCurrentControl = 19
| refreshes the current control More...

## Detailed Description

specifies the operations on a user interface form, as supported by the XFormOperations interface.

Since
  OOo 2.2

## Variable Documentation

## ◆ AutoFilter

const short AutoFilter = 15

adds a filter to the form, which is defined by the active form control and its current value

For instance, if the currently active form control is bound to a table field named `Price`, and currently has a value of `100`, then invoking the `AutoFilter` operation will put an additional filter `Price = 100` on the form.

## ◆ DeleteRecord

const short DeleteRecord = 10

deletes the current record, while honoring any registered com::sun::star::form::XConfirmDeleteListeners

## ◆ InteractiveFilter

const short InteractiveFilter = 16

opens a dialog which allows the user to interactively specify a form filter

## ◆ InteractiveSort

const short InteractiveSort = 14

opens a dialog which allows the user to interactively specify a form sorting order

## ◆ MoveAbsolute

const short MoveAbsolute = 1

moves the form to a record given by absolute position.

This operation cannot be executed without arguments. When executing it (i.e. when calling com::sun::star::form::runtime::XFormOperations::executeWithArguments()), you need to specify a parameter named Position of type `long`, which denotes the position to move the form to.

## ◆ MoveToFirst

const short MoveToFirst = 3

moves the form to the first record

## ◆ MoveToInsertRow

const short MoveToInsertRow = 7

moves the form to the insertion row, if privileges allow

## ◆ MoveToLast

const short MoveToLast = 6

moves the form to the last record

## ◆ MoveToNext

const short MoveToNext = 5

moves the form to the record after the current record, if there is any

## ◆ MoveToPrevious

const short MoveToPrevious = 4

moves the form to the record before the current record, if there is any

## ◆ RefreshCurrentControl

const short RefreshCurrentControl = 19

refreshes the current control

Basically, this means calling XRefreshable::refresh on the current control, if it supports this interface.

Since
  OOo 3.1

## ◆ ReloadForm

const short ReloadForm = 11

reloads the form content

## ◆ RemoveFilterAndSort

const short RemoveFilterAndSort = 18

removes all filter and sort criteria put on the form.

Note that this does not apply to criteria which are part of the form's data source. That is, if you bind the form to the SQL command `SELECT * FROM Articles WHERE Price > 100`, then the `Price > 100` filter will not be removed.

Effectively, this operation resets the com::sun::star::sdb::RowSet::Filter and com::sun::star::sdb::RowSet::Order properties of the form.

## ◆ SaveRecordChanges

const short SaveRecordChanges = 8

saves all changes in the form's current record, including changes in the current control which had not yet been committed to the form

## ◆ SortAscending

const short SortAscending = 12

sorts the form ascending by the field which the active form control is bound to.

## ◆ SortDescending

const short SortDescending = 13

sorts the form descending by the field which the active form control is bound to.

## ◆ ToggleApplyFilter

const short ToggleApplyFilter = 17

toggles the com::sun::star::sdb::RowSet::ApplyFilter property of a the form.

## ◆ TotalRecords

const short TotalRecords = 2

determines the number of total records in the form, including the potentially active insertion row.

This is not strictly an operation you can do on a form, but rather a state you can retrieve (and display to the user) using the XFormOperations's respective methods.

The state obtained here is a string, not a number. This is because in an UI form, the fact that the current record count is not yet known (since not all records have been visited, yet) is indicated by an asterisk (`*`) besides the record count.

## ◆ UndoRecordChanges

const short UndoRecordChanges = 9

reverts all changes in the form's current record, including changes in the current control which had not yet been committed to the form