<html> <head> <title>Constants' Group FormFeature</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimainnone">Use</td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#Constants" class="navisub">Constants</a></td> <td class="navisub"><a href="#ConstantDetails" class="navisub">Constants' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">form</a> :: <a href="module-ix.html" class="namechain">runtime</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">constants group FormFeature</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies the operations on a user interface form, as supported by the <a href="XFormOperations.html">XFormOperations</a> interface. </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> <hr> <a name="Constants"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Constants</td> </tr> <tr> <td class="imsum_left"><a href="#MoveAbsolute">MoveAbsolute</a></td> <td class="imsum_right">moves the form to a record given by absolute position. </td> </tr> <tr> <td class="imsum_left"><a href="#TotalRecords">TotalRecords</a></td> <td class="imsum_right">determines the number of total records in the form, including the potentially active insertion row. </td> </tr> <tr> <td class="imsum_left"><a href="#MoveToFirst">MoveToFirst</a></td> <td class="imsum_right">moves the form to the first record </td> </tr> <tr> <td class="imsum_left"><a href="#MoveToPrevious">MoveToPrevious</a></td> <td class="imsum_right">moves the form to the record before the current record, if there is any </td> </tr> <tr> <td class="imsum_left"><a href="#MoveToNext">MoveToNext</a></td> <td class="imsum_right">moves the form to the record after the current record, if there is any </td> </tr> <tr> <td class="imsum_left"><a href="#MoveToLast">MoveToLast</a></td> <td class="imsum_right">moves the form to the last record </td> </tr> <tr> <td class="imsum_left"><a href="#MoveToInsertRow">MoveToInsertRow</a></td> <td class="imsum_right">moves the form to the insertion row, if privileges allow </td> </tr> <tr> <td class="imsum_left"><a href="#SaveRecordChanges">SaveRecordChanges</a></td> <td class="imsum_right">saves all changes in the form's current record, including changes in the current control which had not yet been committed to the form </td> </tr> <tr> <td class="imsum_left"><a href="#UndoRecordChanges">UndoRecordChanges</a></td> <td class="imsum_right">revertsall changes in the form's current record, including changes in the current control which had not yet been committed to the form </td> </tr> <tr> <td class="imsum_left"><a href="#DeleteRecord">DeleteRecord</a></td> <td class="imsum_right">deletes the current record, while honoring any registered ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XConfirmDeleteListener.html">XConfirmDeleteListener</a>s </td> </tr> <tr> <td class="imsum_left"><a href="#ReloadForm">ReloadForm</a></td> <td class="imsum_right">reloads the form content </td> </tr> <tr> <td class="imsum_left"><a href="#SortAscending">SortAscending</a></td> <td class="imsum_right">sorts the form ascending by the field which the active form control is bound to. </td> </tr> <tr> <td class="imsum_left"><a href="#SortDescending">SortDescending</a></td> <td class="imsum_right">sorts the form descending by the field which the active form control is bound to. </td> </tr> <tr> <td class="imsum_left"><a href="#InteractiveSort">InteractiveSort</a></td> <td class="imsum_right">opens a dialog which allows the user to interactively specify a form sorting order </td> </tr> <tr> <td class="imsum_left"><a href="#AutoFilter">AutoFilter</a></td> <td class="imsum_right">adds a filter to the form, which is defined by the active form control and its current value </td> </tr> <tr> <td class="imsum_left"><a href="#InteractiveFilter">InteractiveFilter</a></td> <td class="imsum_right">opens a dialog which allows the user to interactively specify a form filter </td> </tr> <tr> <td class="imsum_left"><a href="#ToggleApplyFilter">ToggleApplyFilter</a></td> <td class="imsum_right">toggles the ::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/RowSet.html">RowSet</a>::<a href="../../sdb/RowSet.html#ApplyFilter">ApplyFilter</a> property of a the form. </td> </tr> <tr> <td class="imsum_left"><a href="#RemoveFilterAndSort">RemoveFilterAndSort</a></td> <td class="imsum_right">removes all filter and sort criterions put on the form. </td> </tr> </table> <a name="ConstantDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Constants' Details</td> </tr> <tr> <td class="imdetail"><a name="MoveAbsolute" class="membertitle">MoveAbsolute</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>MoveAbsolute</b> = 1;<hr> <dl> <dt><b>Description</b></dt> <dd>moves the form to a record given by absolute position. </dd> <dd><p>This operation cannot be executed without arguments. When executing it (i.e. when calling <a href="XFormOperations.html">XFormOperations</a>::<a href="XFormOperations.html#executeWithArguments">executeWithArguments</a>), you need to specify a parameter named <em>Position</em> of type <code>long</code>, which denotes the position to move the form to.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TotalRecords" class="membertitle">TotalRecords</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>TotalRecords</b> = 2;<hr> <dl> <dt><b>Description</b></dt> <dd>determines the number of total records in the form, including the potentially active insertion row. </dd> <dd><p>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 <a href="XFormOperations.html">XFormOperations</a>' respective methods.</p> <p>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 (<code>*</code>) besides the record count.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MoveToFirst" class="membertitle">MoveToFirst</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>MoveToFirst</b> = 3;<hr> <dl> <dt><b>Description</b></dt> <dd>moves the form to the first record</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MoveToPrevious" class="membertitle">MoveToPrevious</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>MoveToPrevious</b> = 4;<hr> <dl> <dt><b>Description</b></dt> <dd>moves the form to the record before the current record, if there is any</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MoveToNext" class="membertitle">MoveToNext</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>MoveToNext</b> = 5;<hr> <dl> <dt><b>Description</b></dt> <dd>moves the form to the record after the current record, if there is any</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MoveToLast" class="membertitle">MoveToLast</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>MoveToLast</b> = 6;<hr> <dl> <dt><b>Description</b></dt> <dd>moves the form to the last record</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MoveToInsertRow" class="membertitle">MoveToInsertRow</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>MoveToInsertRow</b> = 7;<hr> <dl> <dt><b>Description</b></dt> <dd>moves the form to the insertion row, if privileges allow</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SaveRecordChanges" class="membertitle">SaveRecordChanges</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>SaveRecordChanges</b> = 8;<hr> <dl> <dt><b>Description</b></dt> <dd>saves all changes in the form's current record, including changes in the current control which had not yet been committed to the form </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UndoRecordChanges" class="membertitle">UndoRecordChanges</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>UndoRecordChanges</b> = 9;<hr> <dl> <dt><b>Description</b></dt> <dd>revertsall changes in the form's current record, including changes in the current control which had not yet been committed to the form </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DeleteRecord" class="membertitle">DeleteRecord</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>DeleteRecord</b> = 10;<hr> <dl> <dt><b>Description</b></dt> <dd>deletes the current record, while honoring any registered ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XConfirmDeleteListener.html">XConfirmDeleteListener</a>s </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ReloadForm" class="membertitle">ReloadForm</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>ReloadForm</b> = 11;<hr> <dl> <dt><b>Description</b></dt> <dd>reloads the form content</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SortAscending" class="membertitle">SortAscending</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>SortAscending</b> = 12;<hr> <dl> <dt><b>Description</b></dt> <dd>sorts the form ascending by the field which the active form control is bound to.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SortDescending" class="membertitle">SortDescending</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>SortDescending</b> = 13;<hr> <dl> <dt><b>Description</b></dt> <dd>sorts the form descending by the field which the active form control is bound to.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="InteractiveSort" class="membertitle">InteractiveSort</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>InteractiveSort</b> = 14;<hr> <dl> <dt><b>Description</b></dt> <dd>opens a dialog which allows the user to interactively specify a form sorting order</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AutoFilter" class="membertitle">AutoFilter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>AutoFilter</b> = 15;<hr> <dl> <dt><b>Description</b></dt> <dd>adds a filter to the form, which is defined by the active form control and its current value </dd> <dd><p>For instance, if the currently active form control is bound to a table field named <code>Price</code>, and currently has a value of <code>100</code>, then invoking the <code>AutoFilter</code> operation will put an additional filter <code>Price = 100</code> on the form.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="InteractiveFilter" class="membertitle">InteractiveFilter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>InteractiveFilter</b> = 16;<hr> <dl> <dt><b>Description</b></dt> <dd>opens a dialog which allows the user to interactively specify a form filter</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ToggleApplyFilter" class="membertitle">ToggleApplyFilter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>ToggleApplyFilter</b> = 17;<hr> <dl> <dt><b>Description</b></dt> <dd>toggles the ::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/RowSet.html">RowSet</a>::<a href="../../sdb/RowSet.html#ApplyFilter">ApplyFilter</a> property of a the form. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RemoveFilterAndSort" class="membertitle">RemoveFilterAndSort</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>RemoveFilterAndSort</b> = 18;<hr> <dl> <dt><b>Description</b></dt> <dd>removes all filter and sort criterions put on the form. </dd> <dd><p>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 <code>SELECT * FROM Articles WHERE Price > 100</code>, then the <code>Price > 100</code> filter will not be removed.</p> <p>Effectively, this operation resets the ::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/RowSet.html">RowSet</a>::<a href="../../sdb/RowSet.html#Filter">Filter</a> and ::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/RowSet.html">RowSet</a>::<a href="../../sdb/RowSet.html#Order">Order</a> properties of the form.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
3304
