A collection of DataTable objects. The collection of data tables
exists in the DataManager.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.DataDataTableCollection
Namespace: Spotfire.Dxp.Data
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 30.0.10915.3380 (30.0.10915.3380)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(20, 0)] public sealed class DataTableCollection : DocumentNode, IEnumerable<DataTable>, IEnumerable
The DataTableCollection type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | Add | Create and add a DataTable from a DataSource.
Use CreateFileDataSource(String) to create
a DataSource from a file path.
|
| Contains(Guid) | Check if a table with the given id exists in the
collection.
|
| Contains(String) | Check if a table with the given name exists in the
collection.
|
| Contains(DataTable) | Check if the dataTable exists in this collection.
|
| CreateUniqueName | Create a new unique table name from a suggestion. The
suggested name is used if possible.
|
| GetEnumerator |
Returns an enumerator that iterates through the collection.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsValidName | Check if the suggested table name is a valid unique
name in the collection.
|
| Refresh |
Refreshes the given tables in dependency order.
|
| RefreshAll |
Refreshes the all tables in this collection.
|
| RefreshAsync(IEnumerableDataTable) |
Refreshes the given tables in dependency order. Tables that have asynchronous refresh
(i.e. Data On Demand and Data Functions) and tables that depend on them will be refreshed
in later transactions.
|
| RefreshAsync(IEnumerableDataTable, ActionException) |
Refreshes the given tables in dependency order. Tables that have asynchronous refresh
(i.e. Data On Demand and Data Functions) and tables that depend on them will be refreshed
in later transactions.
|
| Remove(String) | Remove the DataTable with the given name from the
collection.
|
| Remove(DataTable) | Remove the dataTable from the collection.
|
| TryGetValue(Guid, DataTable) | Try to get a DataTable with a given id.
|
| TryGetValue(String, DataTable) | Try to get a DataTable with a given name.
|
Properties
| Name | Description | |
|---|---|---|
 | Context |
Gets the context of this node.
(Inherited from DocumentNode.) |
| Count | Gets the number of tables.
|
| DefaultTableReference | Gets or sets the current default table. The value may not be set
to null but will be null when there are no tables in the collection.
|
| IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) |
| ItemGuid | Gets the table with the given Guidid. |
| ItemString | Gets the table with the given name. |
| Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) |
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
  | IEnumerableGetEnumerator |
Returns an enumerator that iterates through a collection.
|
| IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) |
| INodeContextGetAncestorT |
Implements GetAncestorT.
(Inherited from DocumentNode.) |
| INodeContextGetServiceT |
Implements GetServiceT.
(Inherited from DocumentNode.) |
| INodeContextIsDescendantOf |
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.) |
| ITransactionsBeginAggregatedTransaction |
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.) |
| ITransactionsExecuteInvisibleTransaction |
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.) |
| ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) |
| ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |
Version Information
See Also