A DataTable is a collection of columns and metadata.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.DataDataTable
Spotfire.Dxp.DataDataView
Namespace: Spotfire.Dxp.Data
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(20, 0)] public class DataTable : DocumentNode, IDataPropertyContainer, IDataPropertiesAccessor, IDataTable, IDataPropertyContainerOwner, IMarkableTable, IPersistentDataProvider
The DataTable type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AddColumns | Adds columns from the columns retrieved from the
dataSource using the settings in the
settings parameter. Use
CreateFileDataSource(String) to create a data
source from a file path.
|
| AddRows | Adds rows from the columns retrieved from the
dataSource using the settings in the
settings parameter. Use
CreateFileDataSource(String) to create a data
source from a file path.
|
| BeginRefresh | Obsolete.
Begins a refresh of this table, making it up-to-date with the
current settings. Depending on the table type, data will be reloaded
from the data source or recalculated.
|
 | CreateEventRelay(PropertyName, StatelessDependencyDeclarer) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
| CreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoableListT) |
Creates an UndoableListT and assigns it to the specified field.
The UndoableListT will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoableSetT) |
Creates an UndoableSetT and assigns it to the specified field.
The UndoableSetT will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) |
Creates an UndoableCrossReferencePropertyT and assigns it to the specified field.
The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoablePropertyT, T) |
Creates an UndoablePropertyT and assigns it to the specified field.
The UndoablePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
| CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) |
Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field.
The UndoableDictionaryTKey, TValue will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) |
Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field.
The UndoableKeyedCollectionTKey, TNode will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreateReadOnlyPropertyT |
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.) |
| CreateRuntimeConstantT |
Creates a runtime constant. A runtime constant is a property in the document model
whose value is computed once when first accessed. The value is then disposed
along with the DocumentNode.
(Inherited from DocumentNode.) |
| CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) | Obsolete.
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) |
| CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) |
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) |
| DeclareInternalEventHandlers | Override this method to declare handlers of internal events.
(Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) |
Deserializes an UndoableCrossReferencePropertyT with value of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) | (Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) | (Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) | (Inherited from DocumentNode.) |
| DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) | (Inherited from DocumentNode.) |
| DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) | (Inherited from DocumentNode.) |
| DeserializeReadOnlyPropertyT |
Deserializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| DuplicateSubtreeT | Returns a copy of the sub tree spanned from this node that
has the same outwards non-owning references. The returned copy will
be in state New and is intended to be attached to the document
immediately. (Inherited from DocumentNode.) |
| EndRefresh | Obsolete. Waits until the currently executing refresh operation is
finished.
|
| ExportDataToLibrary |
Export the data in the data table as a data file in the library.
|
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetDistinctRows |
Gets the distinct rows for the specified cursors. Note that this method is not supported for external data tables.
|
| GetMethods |
Gets the methods that can be used in expressions on this table.
|
| GetPersistedTypeName | Can be used in the deserialization constructor to get the type name that the class
corresponding to this class had when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
| GetPersistedVersion | Can be used in the deserialization constructor to get the persistence version that this class
was marked with when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
 | GetRows(DataValueCursor) |
Enumerates all rows for the columns specified by the given valueCursors.
|
| GetRows(IEnumerableInt32, DataValueCursor) |
Enumerates a subset of the rows for the columns specified by the given valueCursors |
| GetService | Override this method to provide services accessible
from this node and its descendants.
If you can not provide the requested service, you should call
base.GetService which relays the request to the owner
or to the AnalysisApplication if no owner is set.
(Inherited from Node.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InternalTransaction |
Starts an internal transaction on the document model by
executing the specified executor delegate.
(Inherited from DocumentNode.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnConfigure |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
| OnConfigured |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
| OnReconfigure |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
| OnReconfigured |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
| Refresh |
Refreshes this table to be up-to-date with the current settings. This will reload data from
the DataSource or recalculate depending on the type of table.
|
| RemoveRows | Remove rows from this table.
|
| ReplaceData | Replace the data in the table with the columns in the data
source. Use CreateFileDataSource(String) to create
a data source from a file path.
|
| Select |
Returns the rows that matches the where clause expression.
The expression must be a boolean Spotfire expression.
|
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT) | Serializes an Undoable*Property with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT) | Serializes an UndoableList with values of type T
storing it in info with key list.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT) | Serializes an UndoableProperty with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT) | Serializes an UndoableSet storing it in info
with key given by the property name of the set.
(Inherited from DocumentNode.) |
| SerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue) | Serializes an UndoableDictionary storing it in info
with key given by the property name of the dictionary.
(Inherited from DocumentNode.) |
| SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) |
Serializes an UndoableKeyedCollectionTKey, TNode storing it in info
with key given by the property name of the keyedCollection.
(Inherited from DocumentNode.) |
| SerializeReadOnlyPropertyT |
Serializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| ValidateAttached | Validates that the node is attached.
(Inherited from DocumentNode.) |
Properties
| Name | Description | |
|---|---|---|
 | Columns | Gets the collection of the columns that are part of this data table.
|
| Context |
Gets the context of this node.
(Inherited from DocumentNode.) |
| HasValidPrimaryKey | Gets a value indicating whether the table has a valid primary key or not.
|
| Id | Gets a unique identifier for this table.
|
| IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) |
| IsExternal |
Gets a value indicating whether the data in this table is kept external.
|
| IsRefreshable |
Gets a value indicating whether this table is refreshable, that is,
it supports Refresh calls.
|
| IsRefreshableByNeed |
Gets a value indicating whether this table is refreshable by need, that is,
it supports Refresh calls and uses the NeedsRefresh
property to indicate if refresh is needed.
|
| Name | Gets or sets the name of this table.
|
| NameEscapedForExpression | Gets the name of the table escaped for usage in an
expression. This is a utility method which uses
EscapeIdentifier(String).
|
| NeedsRefresh |
Gets a value indicating whether this table needs to be refreshed (by calling Refresh).
|
| PrimaryKey |
Gets or sets the primary key for this data table. The primary
key is a collection of columns in this table that provides a unique
combination of values for each row.
|
| Properties | Gets the properties describing this table.
|
| Refreshing |
Gets a value indicating whether the data table is refreshing.
|
| RowCount | Gets the number of rows in the columns in this table. All columns in a DataTable
have the same number of rows.
|
| Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) |
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
  | 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.) |
Remarks
Version Information
See Also