BcfDataSet Class |
[This is preliminary documentation and is subject to change.]
The cool transactional object model.
Inheritance HierarchyNamespace: CalculationWorks.BusinessModel
Assembly: CalculationWorks.BusinessModel (in CalculationWorks.BusinessModel.dll) Version: 4.0.0-beta7
SyntaxThe BcfDataSet type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BcfDataSet |
Initializes a new instance of the BcfDataSet class.
|
Properties| Name | Description | |
|---|---|---|
 | AcceptedDataStateId |
Gets the CurrentDataStateId from last AcceptChanges call.
|
| Calculating |
Gets a value indicating whether this BcfDataSet is currently calculating.
|
| CurrentCalculationPlan |
Get the current calculation plan.
|
| CurrentDataStateId |
Gets an identifier representing the current data state.
|
| CurrentTransaction |
Gets the current BcfTransaction.
|
| Faults |
Gets the collection of BcfFault objects.
|
| HandleCalculationException |
Allows to control exception-handling in calculation. Default is null.
|
| HasChanges |
Gets a value indicating whether data was updated since last call of AcceptChanges.
|
| IsDisposed |
Gets a value indicating whether this instance is disposed.
|
| IsUndoEnabled |
Gets a value indicating whether undo (collecting data for Undo(Int32) and Redo(Int32)) is enabled.
|
| Locked |
Gets a value indicating whether this BcfDataSet is currently locked.
|
| ManageStateId |
Gets or sets a value indicating the dataset manages CurrentDataStateId. Default is true.
|
| Name |
Gets the name of the dataset.
|
| ParallelOptions |
Gets calculation options.
|
| Relations |
Get the collection of relations that link tables and allow parameter access from parent tables to child tables and vice versa.
|
| ReleasingDataChanged |
Gets a value indicating whether invocation of DataChanged is in process.
|
| Tables |
Gets the collection of tables contained in the dataset.
|
| TransactionFactory |
Gets the transaction factory.
|
| UndoRepository |
Gets the undo repository.
|
| UndoSerializationService |
Infrastructure. The member supports the infrastructure and is not intended to be used directly from your code.
|
Methods| Name | Description | |
|---|---|---|
| AcceptChanges | |
| BeginTransaction(BcfTransactionBuilder) |
Creates a BcfTransaction and sets it as the CurrentTransaction. If CurrentTransaction is not null when calling BeginTransaction(BcfTransactionBuilder) a subtransaction of CurrentTransaction will be created.
|
| BeginTransaction(String, NullableBoolean) |
Creates a transaction and sets it as the CurrentTransaction. If CurrentTransaction is not null before calling BeginTransaction a subtransaction of the CurrentTransaction will be created.
|
| CanRedo |
Determines whether Redo(Int32) can be executed.
|
| CanUndo |
Determines whether Undo(Int32) can be executed.
|
| CreateTempDataSet |
Creates an empty dataset with a compatible schema but without functions and rules.
|
| Diff |
Evalueates the difference between this an specified otherDataSet.
|
| DisableUndo | |
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
 | Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources.
|
| EnableFileUndo |
Enables collecting data-changes (collecting data for Undo(Int32) and Redo(Int32)) in streams.
|
| EnableFileUndoSession |
Enables collecting data-changes (collecting data for Undo(Int32) and Redo(Int32)) in streams including initial data state.
|
| EnableMemoryUndo |
Enables collecting data-changes (collecting data for Undo(Int32) and Redo(Int32)) in memory.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Load(BcfDataSet, FuncBcfColumn, Boolean, BcfRowMergeOption, Boolean, BcfRowComparisonMode) |
Loads rows of specified dataSet and returns the row-map.
|
| Load(IEnumerableBcfRow, FuncBcfColumn, Boolean, BcfRowMergeOption, Boolean, BcfRowComparisonMode) |
Loads rows of specified distinctSourceRows and returns the row-map.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnBeginCompute |
Called when calculations begins after the calculation-plan is initialized (see CurrentCalculationPlan).
|
| OnBeginRedo |
Called when Redo(Int32) begins.
|
| OnBeginUndo |
Called when Undo(Int32) begins.
|
| OnDataChanged |
Raises the DataChanged-event.
|
| OnDisposed |
Raises the Disposed event.
|
| OnEndCompute |
Called when calculations ends just before the calculation-plan is cleared (see CurrentCalculationPlan).
|
| OnEndRedo |
Called when Redo(Int32) ends.
|
| OnEndUndo |
Called when Undo(Int32) ends.
|
| Redo |
Redoes the last transactionCount undone transactions and returns the effective number of redone transactions.
|
| Reset |
Deletes all rows of all tables non transactional, clears UndoRepository and resets the row-id generators and column sequences.
|
| RestoreUndoRepository |
Restores a file-based undo repository and initial dataset state (data when called EnableFileUndoSession(Stream, Stream, Byte)), enables undo and returns the last known transaction index.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Undo |
Undoes the last transactionCount transactions and returns the effective number of undone transactions.
|
Events| Name | Description | |
|---|---|---|
 | DataChanged |
Raised when main-transaction with data changes is committed and in Reset.
|
| Disposed |
Occurs when disposed.
|
See Also