| Constants |
| MoveAbsolute |
moves the form to a record given by absolute position.
|
| TotalRecords |
determines the number of total records in the form,
including the potentially active insertion row.
|
| MoveToFirst |
moves the form to the first record |
| MoveToPrevious |
moves the form to the record before the current record, if there is any |
| MoveToNext |
moves the form to the record after the current record, if there is any |
| MoveToLast |
moves the form to the last record |
| MoveToInsertRow |
moves the form to the insertion row, if privileges allow |
| SaveRecordChanges |
saves all changes in the form's current record, including changes in the current
control which had not yet been committed to the form
|
| UndoRecordChanges |
revertsall changes in the form's current record, including changes in the current
control which had not yet been committed to the form
|
| DeleteRecord |
deletes the current record, while honoring any registered
::com::sun::star::form::XConfirmDeleteListeners
|
| ReloadForm |
reloads the form content |
| SortAscending |
sorts the form ascending by the field which the active form control is bound to. |
| SortDescending |
sorts the form descending by the field which the active form control is bound to. |
| InteractiveSort |
opens a dialog which allows the user to interactively specify a form sorting order |
| AutoFilter |
adds a filter to the form, which is defined by the active form control and its
current value
|
| InteractiveFilter |
opens a dialog which allows the user to interactively specify a form filter |
| ToggleApplyFilter |
toggles the ::com::sun::star::sdb::RowSet::ApplyFilter property
of a the form.
|
| RemoveFilterAndSort |
removes all filter and sort criterions put on the form.
|
| RefreshCurrentControl |
refreshs the current control
|
| Constants' Details |
MoveAbsolute
const short MoveAbsolute = 1;
- Description
- moves the form to a record given by absolute position.
This operation cannot be executed without arguments. When executing it (i.e.
when calling XFormOperations::executeWithArguments),
you need to specify a parameter named Position of type long, which
denotes the position to move the form to.
|
|
TotalRecords
const short TotalRecords = 2;
- Description
- 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'
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 asterik (*) besides
the record count.
|
|
MoveToFirst
const short MoveToFirst = 3;
- Description
- moves the form to the first record
|
|
MoveToPrevious
const short MoveToPrevious = 4;
- Description
- moves the form to the record before the current record, if there is any
|
|
MoveToNext
const short MoveToNext = 5;
- Description
- moves the form to the record after the current record, if there is any
|
|
MoveToLast
const short MoveToLast = 6;
- Description
- moves the form to the last record
|
|
MoveToInsertRow
const short MoveToInsertRow = 7;
- Description
- moves the form to the insertion row, if privileges allow
|
|
SaveRecordChanges
const short SaveRecordChanges = 8;
- Description
- saves all changes in the form's current record, including changes in the current
control which had not yet been committed to the form
|
|
UndoRecordChanges
const short UndoRecordChanges = 9;
- Description
- revertsall changes in the form's current record, including changes in the current
control which had not yet been committed to the form
|
|
DeleteRecord
const short DeleteRecord = 10;
- Description
- deletes the current record, while honoring any registered
::com::sun::star::form::XConfirmDeleteListeners
|
|
ReloadForm
const short ReloadForm = 11;
- Description
- reloads the form content
|
|
SortAscending
const short SortAscending = 12;
- Description
- sorts the form ascending by the field which the active form control is bound to.
|
|
SortDescending
const short SortDescending = 13;
- Description
- sorts the form descending by the field which the active form control is bound to.
|
|
InteractiveSort
const short InteractiveSort = 14;
- Description
- opens a dialog which allows the user to interactively specify a form sorting order
|
|
AutoFilter
const short AutoFilter = 15;
- Description
- 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.
|
|
InteractiveFilter
const short InteractiveFilter = 16;
- Description
- opens a dialog which allows the user to interactively specify a form filter
|
|
ToggleApplyFilter
const short ToggleApplyFilter = 17;
- Description
- toggles the ::com::sun::star::sdb::RowSet::ApplyFilter property
of a the form.
|
|
RemoveFilterAndSort
const short RemoveFilterAndSort = 18;
- Description
- removes all filter and sort criterions put on the form.
Note that this does not apply to criterios 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.
|
|
RefreshCurrentControl
const short RefreshCurrentControl = 19;
- Description
- refreshs the current control
Basically, this means calling XRefreshable::refresh on the current control, if it supports
this interface.
- Since
- OOo 3.1
|
|
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.
