ICommenceCursor Interface |
Namespace: Vovin.CmcLibNet.Database
The ICommenceCursor type exposes the following members.
| Name | Description | |
|---|---|---|
| Category |
Name of the category this cursor is based on.
| |
| ColumnCount |
Number of columns in cursor.
| |
| Columns |
Allows for setting multiple direct and related columns at once.
| |
| Filters |
Gets collection of filters to be applied on cursor.
It is recommended you use this property over setting filterstrings directly.
| |
| MaxFieldSize |
Maximum field size. Gets the maximum number of characters that can be read from a Commence field. Undocumented by Commence.
The default value is 93750.
| |
| MaxRows |
Maximum number of rows a cursor can contain. Undocumented by Commence. Effectively a measure for database capacity.
| |
| RowCount |
Number of items in cursor.
| |
| Shared |
(read-only) TRUE if category is shared in a workgroup.
| |
| View |
Name of the View if cursor is based on a view.
|
| Name | Description | |
|---|---|---|
| Close |
Close any references to Commence. The object should be disposed after this.
| |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) | |
| ExportToFile |
Exports current cursor to a file. WARNING: The cursor is disposed after this method!
| |
| GetAddRowSet |
Create a rowset of new items to add to the database.
| |
| GetColumnNames |
Get columnames from cursor. Defaults to fieldnames
| |
| GetDeleteRowSet(CmcOptionFlags) |
Create a rowset of ALL existing items for deletion. Use with care!
| |
| GetDeleteRowSet(Int32, CmcOptionFlags) |
Create a rowset of n items for deletion.
| |
| GetDeleteRowSetByID |
Create a rowset for deleting a particular row.
| |
| GetEditRowSet(CmcOptionFlags) |
Create a rowset of all existing items for editing. Be careful when handling very large rowsets.
| |
| GetEditRowSet(Int32, CmcOptionFlags) |
Create a rowset of existing items for editing.
| |
| GetEditRowSetByID |
Create a rowset for editing a particular row.
| |
| GetQueryRowSet(CmcOptionFlags) |
Create a rowset object with the results of a query.
| |
| GetQueryRowSet(Int32, CmcOptionFlags) |
Create a rowset object with the results of a query.
| |
| GetQueryRowSetByID |
Create a rowset object with a particular row loaded.
| |
| GetQueryRowSetByThid |
Create a rowset object with a particular thid loaded. Only applies to shared items. Cursor must have the thids thids flag.
| |
| HasDuplicates |
Checks if field contains duplicate values.
| |
| ReadAllRows |
Read all data from a cursor.
This method is just a convenient way to return data without having to create a ICommenceQueryRowSet. Keep in mind reading data from Commence is quite slow! For more advanced reading and export options see IExportEngine. | |
| ReadRow |
Reads specified row from the cursor.
This method is just a convenient way to return data without having to create a ICommenceQueryRowSet. If you need to apply formatting, see the IExportEngine interface. | |
| SeekRow |
Seek to row in cursor.
| |
| SeekRowApprox |
Move a fractional number of rows.
| |
| SetActiveDate |
Set active date used for view cursors using a view linking filter.
| |
| SetActiveDateRange |
Set active date range used for view cursors using a view linking filter.
| |
| SetActiveItem |
Set active item used for view cursors using a view linking filter.
| |
| SetColumn |
Defines the column set for the cursor
| |
| SetColumns |
Allows for setting direct columns in batch-mode
| |
| SetFilter |
Defines the filter for the cursor.
Not recommended, use Filters instead.
| |
| SetLogic |
Defines the filter logic for the cursor.
Not recommended, use Filters instead.
| |
| SetRelatedColumn |
Define column for a connected field. Allows for retrieving other than just the Name field from connections.
| |
| SetSort |
Defines the sort criteria for the cursor. Use this only if you apply filters with the SetFilter method. You are strongly advised to use the Filters collection instead.
|