Overview | Module | Use | Devguide | Index

Constants | Constants' Details

:: com :: sun :: star :: form :: runtime ::
unpublished | constants group FormFeature |
Usage Restrictions not published Description specifies the operations on a user interface form, as supported by the XFormOperations interface. Since OOo 2.2

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 | reverts all 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 criteria put on the form.
RefreshCurrentControl | refreshes 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'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.
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 reverts all 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 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.
RefreshCurrentControl
const short RefreshCurrentControl = 19; Description refreshes the current control Basically, this means calling XRefreshable::refresh on the current control, if it supports this interface. Since OOo 3.1

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.