| Name | Description | |
|---|---|---|
 | ActiveIndex | Name of active index that determines row order when walking the table with First(), Last(), Prev(), and Next() and when applying SetScope(...), etc. A null setting for ActiveIndex selects the table's natural storage order (generally the order rows were originally inserted). |
| CurrentKey | Gets a copy of the current key row under the ActiveIndex, or sets the current key row from the row instance provided (such as from a previous get under the same ActiveIndex). Copies returned by get can be modifed and used in SetScope. |
| CurrentRow | Gets a copy of the entire current row of the table, or sets the modified column values into the pending-row placeholder to be submitted by a Post for update or insert. DO NOT MIX setting CurrentRow and using Put... methods on the table for the same operation. |
| EndOfTable | Tests if a record movement function has placed the row pointer beyond the last row in the table under the ActiveIndex (also true if the table is empty). |
| EnforceConstraints | Gets or sets a value indicating whether constraint rules are followed when attempting any insert, update or delete operation |
| EnforceIdentities | Gets or sets a value indicating whether identities are active when attempting any insert operation |
| IdentityInsert | Get or set the manual setting for IDENTITY_INSERT ON (true) or OFF (false) for this table. This is independent from the one-table-at-a-time setting for a SQL connection but provides the same basic functionality to allow explicit value insertion for identity columns. |
| IsClosed | Get the value indicating whether the table is closed |
| LastSessionIdentity | Read the memory-cached value of last insert operation made to the identity columns by this table instance |
| LastTableIdentity | Read the last value of identity columns that will be used by any client in nearest insert operation. This value is saved in the file storage. |
| Name | Table name |
| RegularIndexes | Get collection of regular indexes created and/or opened in this table instance |
| RowCount | Number of physical rows in the table |
| ScopeKeyCount | Scans active index and calculates the keys in it, taking current scope operators into account. (WARNING: CAUSES SIDE-EFFECTS: The current row position of the parent table becomes undefined/EOF) |
| StartOfTable | Tests if a record movement function has placed the row pointer before the first row in the table under the ActiveIndex (also true if the table is empty). |
| TemporaryIndexes | Get collection of temporary indexes created and assigned to this table instance |
IVistaDBTable Interface Members
In This Topic
The following tables list the members exposed by IVistaDBTable.
Public Properties
Public Methods
| Name | Description | |
|---|---|---|
 | Close | Close the table and clear respective resources |
| CreateConstraint | Create constraint to check after insert, update or before delete operations |
| CreateDefaultValue | Create a default value for a column using an expression. |
| CreateForeignKey | Create foreign key constraint that instantiates respective relationship in the database |
| CreateFTSIndex | Create special index to use by full text search. Identity columns may not be used for FullTextSearch indexes. Only a single FullTextSearch index may exist per table. |
| CreateIdentity | Create and initialize identity counter. Applied to integer type columns only. |
| CreateIndex | Create an index on current table. This may be a unique constrained index, or a primary key index. |
| CreateTemporaryIndex | Create temporary index from given keyExpression. The index is not added to database but kept separately in the user temporary folder. The file is deleted by engine when the table is closed. |
| Delete | Immediately deletes current row and reset row lock if it was set before delete operation. |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from System.IDisposable) |
| DropConstraint | Drop existing constraint |
| DropDefaultValue | Drop an existing default value |
| DropForeignKey | Drop foreign key constraint. Respective foreign key index will be deleted from the table as well. |
| DropFTSIndex | Drop full text search index. No params are required as there may be only one Full Text Search (FTS) Index per table. |
| DropIdentity | Drop existing identity column |
| DropIndex | Drop existing index |
| Evaluate | Evaluate expression. |
| ExportData | To export table data using constraint set on destination table. |
| Find | Overloaded. Find an expression in an index. This is for searching for exact and partial matching records. |
| First | Set current row pointer to the first row position under the current ActiveIndex (and any applied scope). If there are no rows, the EndOfTable flag is set to true. |
| Get | Overloaded. Get column value by column's name |
| GetFilter | Gets filter expression for current table state. |
| GetScope | Gets copies of the lower and upper key rows of the currently set scope constraining the range of rows under the current ActiveIndex. (Columns will all be set to extreme values if no scope has been set.) |
| GetToFile | Overloaded. Read Text, NText, Image data from database and put them to external file. |
| Insert | Start an insert operation and create a placeholder row in memory. Values can then be set either by calling various Put... methods on the table OR by getting the CurrentRow and then assigning back to CurrentRow after setting column values in the instance. Submit by calling Post or Post(Boolean). |
| Last | Set current row pointer to the last row position under the current ActiveIndex (and any applied scope). If there are no rows, the EndOfTable flag is set to true. |
| Lock | Lock row. If zero is passed, the entire table will be locked |
| MoveBy | Advances current row pointer position by a specified number of rows forward (positive) or back (negative) under the current ActiveIndex. |
| Next | Advances current row pointer to the next row under the current ActiveIndex. If there were no more rows to move forward to, the EndOfTable flag will be set to true. |
| Post | Overloaded. Finalize a pending insert or update operation and optionally release the row lock or leave it locked for further action. |
| Prev | Move current row pointer to the previous row under the current ActiveIndex. If there were no previous rows to move back to, the StartOfTable flag will be set to true. |
| Put | Overloaded. Assign column value with system type value by column order in the row. |
| PutBinary | Overloaded. Assign array of bytes value to column by column's name |
| PutBoolean | Overloaded. Assign boolean value to column by column's name |
| PutByte | Overloaded. Assign byte value to column by column's name |
| PutDateTime | Overloaded. Assign DateTime value to column by column's name |
| PutDateTimeOffset | Overloaded. Assign DateTimeOffset value to column by column's name |
| PutDecimal | Overloaded. Assign Decimal value to column by column's name |
| PutDouble | Overloaded. Assign Double value to column by column's name |
| PutFromFile | Overloaded. Put Text, NText, Image data from external file to a column. |
| PutGuid | Overloaded. Assign Guid value to column by column's name |
| PutInt16 | Overloaded. Assign int16 value to column by column's name |
| PutInt32 | Overloaded. Assign int32 value to column by column's name |
| PutInt64 | Overloaded. Assign int64 value to column by column's name |
| PutNull | Overloaded. Set null value by column's name |
| PutSingle | Overloaded. Assign Float value to column by column's name |
| PutString | Overloaded. Assign string value to column by column's name |
| PutTime | Overloaded. Assign TimeSpan value to column by column's name |
| RenameIndex | Rename existing index without rebuilding. |
| ResetEventDelegate | Reset event delegate type called by DDA |
| ResetFilter | Reset all filters |
| ResetScope | Reset scope in active index to the entire table. |
| SetDDAEventDelegate | Set delegate method called by core engine by event |
| SetFilter | Set filter expression and try to optimize it if the optimize parameter is true |
| SetOperationCallbackDelegate | Defines a delegate that time consuming operations may call back in order to inform the user as to the progress of the operation and additional information. |
| SetScope | Overloaded. Set the scope for the table to constrain the range of rows under the ActiveIndex. After setting an ActiveIndex on the table (or null to use natural storage order) you can get copies from the CurrentKey property for row instances with the correct schema to use as the arguments. |
| Unlock | Unlock row. If zero is passed, the entire table will be unlocked and all existing row locks will be released |
See Also