DataTable Class

TIBCO Spotfire 11.8 API Reference
A DataTable is a collection of columns and metadata.
Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.DataDataTable
        Spotfire.Dxp.DataDataView

Namespace:  Spotfire.Dxp.Data
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 55.0.17008.5965 (55.0.17008.5965)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(29, 0)]
public class DataTable : DocumentNode

The DataTable type exposes the following members.

Constructors

  NameDescription
Protected methodDataTable
Initializes a new instance of the DataTable class. Implements ISerializable.
Top
Properties

  NameDescription
Public propertyAutoCreateFilters
Gets or sets a value indicating whether to automatically create filters for new columns.
Public propertyColumns
Gets the collection of the columns that are part of this data table.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyHasValidPrimaryKey
Gets a value indicating whether the table has a valid primary key or not.
Public propertyId
Gets a unique identifier for this table.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyIsExternal
Gets a value indicating whether the data in this table is kept external.
Public propertyIsRefreshable Obsolete.
Gets a value indicating whether this table is refreshable, that is, it supports Refresh calls.
Public propertyIsRefreshableByNeed
Gets a value indicating whether this table is refreshable by need, that is, it supports RefreshOnDemandData calls and uses the NeedsRefresh property to indicate if refresh is needed.
Public propertyName
Gets or sets the name of this table.
Public propertyNameEscapedForExpression
Gets the name of the table escaped for usage in an expression. This is a utility method which uses EscapeIdentifier(String).
Public propertyNeedsRefresh
Gets a value indicating whether this table needs to be refreshed (by calling RefreshOnDemandData).
Public propertyPrimaryKey
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.
Public propertyProperties
Gets the properties describing this table.
Public propertyRefreshing
Gets a value indicating whether the data table is refreshing.
Public propertyRowCount
Gets the number of rows in the columns in this table. All columns in a DataTable have the same number of rows.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Top
Methods

  NameDescription
Public methodAddColumns
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.
Public methodAddRows
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.
Public methodAddTransformation
Adds a transformation to the table. The transformation will be applied on the source columns in the table (i.e., the columns originating from a data source or the result of an add columns or add rows operation.) Calculated columns will not be affected.
Public methodAddTransformations
Adds a sequence of transformations to the table. The transformation will be applied on the source columns in the table (i.e., the columns originating from a data source or the result of an add columns or add rows operation.) Calculated columns will not be affected.
Public methodCanReloadAllData
Gets a value indicating whether the data table can be reloaded using the ReloadAllData method.
Public methodCanReloadLinkedData
Gets a value indicating whether the data table can be reloaded using the ReloadLinkedData method.
Protected methodCreateEventRelay(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.)
Protected methodCreateEventRelay(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.)
Protected methodCreatePropertyT(PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected methodCreatePropertyT(PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected methodCreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) (Inherited from DocumentNode.)
Protected methodCreatePropertyT(PropertyName, UndoablePropertyT, T) (Inherited from DocumentNode.)
Protected methodCreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected methodCreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodCreateReadOnlyPropertyT
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.)
Protected methodCreateRuntimeConstantT
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.)
Protected methodCreateRuntimePropertyT (Inherited from DocumentNode.)
Protected methodDeclareInternalEventHandlers
Declares internal event handlers.
(Overrides DocumentNodeDeclareInternalEventHandlers(InternalEventManager).)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected methodDeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodDeserializeReadOnlyPropertyT
Deserializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodDuplicateSubtreeT
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.)
Public methodExportDataToLibrary
Export the data in the data table as a data file in the library.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGenerateSourceView
Generates a SourceView representing DataOperations performed to construct this data table.
Public methodGetDistinctRows
Gets the distinct rows for the specified cursors. Note that this method is not supported for external data tables.
Public methodGetMethods
Gets the methods that can be used in expressions on this table.
Protected methodGetObjectData
Implements ISerializable.
(Overrides DocumentNodeGetObjectData(SerializationInfo, StreamingContext).)
Protected methodGetPersistedTypeName
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.)
Protected methodGetPersistedVersion
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.)
Public methodCode exampleGetRows(DataValueCursor)
Enumerates all rows for the columns specified by the given valueCursors.
Public methodCode exampleGetRows(IEnumerableInt32, DataValueCursor)
Enumerates a subset of the rows for the columns specified by the given
valueCursors
s.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInternalTransaction
Starts an internal transaction on the document model by executing the specified executor delegate.
(Inherited from DocumentNode.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnConfigure
This method is only kept for backward compatibility.
(Overrides DocumentNodeOnConfigure.)
Protected methodOnConfigured
Allows a node to configure itself to the surrounding document.
(Overrides DocumentNodeOnConfigured.)
Protected methodOnReconfigure
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigured
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Public methodRefresh Obsolete.
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.
Public methodRefreshOnDemandData
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.
Public methodRefreshOnDemandData(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.
Public methodReloadAllData
Reloads all data in this data table including data sources set to store their data.
Public methodReloadLinkedData
Reloads only linked data in this data table.
Public methodRemoveRows
Remove rows from this table.
Public methodReplaceData
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.
Public methodSelect
Returns the rows that matches the where clause expression. The expression must be a boolean Spotfire expression.
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT)
Serializes an Undoable*Property with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableListT)
Serializes an UndoableList with values of type T storing it in info with key list.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT)
Serializes an UndoableProperty with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT)
Serializes an UndoableSet storing it in info with key given by the property name of the set.
(Inherited from DocumentNode.)
Protected methodSerializePropertyTKey, 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.)
Protected methodSerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodSerializeReadOnlyPropertyT
Serializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Top
Remarks

No public constructors are defined for a data table, see the DataTableCollection class for creation methods.
Version Information

Supported in: 11.8, 11.7, 11.6, 11.5, 11.4, 11.3, 11.2, 11.1, 11.0, 10.10, 7.11
See Also

Reference