A collection of DataTable objects. The collection of data tables
exists in the DataManager.
Inheritance Hierarchy
Node
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.DataDataTableCollection
Namespace: Spotfire.Dxp.Data
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(20, 0)] public sealed class DataTableCollection : DocumentNode, IEnumerable<DataTable>, IEnumerable
The DataTableCollection type exposes the following members.
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.) |
Methods
| Name | Description | |
|---|---|---|
 | Add(String, DataSource) | Create and add a DataTable from a DataSource.
Use CreateFileDataSource(String) to create
a DataSource from a file path.
|
| Add(String, DataSource, Boolean) | Create and add a DataTable from a DataSource.
Use CreateFileDataSource(String) to create
a DataSource from a file path.
|
| CanReloadAllData |
Gets a value indicating whether any data tables can be reloaded using the
ReloadAllData method.
|
| CanReloadAllData(IEnumerableDataTable) |
Gets a value indicating whether any of the specified data tables can be reloaded using the
ReloadAllData(IEnumerableDataTable) method.
|
| CanReloadLinkedData |
Gets a value indicating whether any data tables can be reloaded using the
ReloadLinkedData method.
|
| CanReloadLinkedData(IEnumerableDataTable) |
Gets a value indicating whether any of the specified data tables can be reloaded using the
ReloadLinkedData(IEnumerableDataTable) method.
|
| 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 | Obsolete.
Refreshes the given tables in dependency order.
|
| RefreshAll | Obsolete.
Refreshes the all tables in this collection.
|
| RefreshAsync(IEnumerableDataTable) | Obsolete.
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) | Obsolete.
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.
|
| RefreshOnDemandData |
Refreshes data that depends on other data and is not automatically updated.
This includes on-demand data with manual refresh, data functions with update behavior Manual
and calculations with update behavior Invalidate.
|
| RefreshOnDemandData(Action) |
Refreshes data that depends on other data and is not automatically updated.
This includes on-demand data with manual refresh, data functions with update behavior Manual
and calculations with update behavior Invalidate.
|
| RefreshOnDemandData(IEnumerableDataTable) |
Refreshes data that depends on other data and is not automatically updated.
This includes on-demand data with manual refresh, data functions with update behavior Manual
and calculations with update behavior Invalidate.
|
| RefreshOnDemandData(IEnumerableDataTable, Action) |
Refreshes data that depends on other data and is not automatically updated.
This includes on-demand data with manual refresh, data functions with update behavior Manual
and calculations with update behavior Invalidate.
|
| ReloadAllData |
Reloads all data in all data tables, including embedded data tables and data sources set to store their data.
|
| ReloadAllData(IEnumerableDataTable) |
Reloads all data in the specified data tables, including embedded data tables and data sources set to store their data.
|
| ReloadLinkedData |
Reloads only linked data in all data tables. Embedded data tables and data sources set to store their
data will be ignored.
|
| ReloadLinkedData(IEnumerableDataTable) |
Reloads only linked data in the specified data tables. Embedded data tables and data sources set to store their
data will be ignored.
|
| Remove(String) | Remove the DataTable with the given name from the
collection.
|
| Remove(DataTable) | Remove the dataTable from the collection.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TryGetValue(Guid, DataTable) | Try to get a DataTable with a given id.
|
| TryGetValue(String, DataTable) | Try to get a DataTable with a given name.
|
Explicit Interface Implementations
Version Information
Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also