DataTable Members TIBCO Spotfire 6.5 API Reference
The DataTable type exposes the following members.
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 methodBeginRefreshObsolete.
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.
Protected methodCreateEventRelay
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 methodCreateProperty T (PropertyName, UndoableList T  ) (Inherited from DocumentNode.)
Protected methodCreateProperty T (PropertyName, UndoableSet T  ) (Inherited from DocumentNode.)
Protected methodCreateProperty TNode (PropertyName, UndoableCrossReferenceProperty TNode  , TNode) (Inherited from DocumentNode.)
Protected methodCreateProperty T (PropertyName, UndoableProperty T  , T) (Inherited from DocumentNode.)
Protected methodCreateProperty TKey, TValue (PropertyName, UndoableDictionary TKey, TValue  ) (Inherited from DocumentNode.)
Protected methodCreateProperty TKey, TNode (PropertyName, PropertyName, UndoableKeyedCollection TKey, TNode  ) (Inherited from DocumentNode.)
Protected methodCreateReadOnlyProperty T 
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.)
Protected methodCreateRuntimeConstant T 
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 methodCreateRuntimeProperty T (PropertyName, RuntimeProperty T  , DependencyDeclarer, PropertyComputer T )Obsolete. (Inherited from DocumentNode.)
Protected methodCreateRuntimeProperty T (PropertyName, RuntimeProperty T  , StatelessDependencyDeclarer, StatelessPropertyComputer T ) (Inherited from DocumentNode.)
Protected methodDeclareInternalEventHandlers
Override this method to declare handlers of internal events.
(Inherited from DocumentNode.)
Protected methodDeserializeProperty T (SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferenceProperty T  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty T (SerializationInfo, StreamingContext, PropertyName, UndoableList T  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty T (SerializationInfo, StreamingContext, PropertyName, UndoableProperty T  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty T (SerializationInfo, StreamingContext, PropertyName, UndoableSet T  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty TKey, TValue (SerializationInfo, StreamingContext, PropertyName, UndoableDictionary TKey, TValue  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty TKey, TNode (SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollection TKey, TNode  ) (Inherited from DocumentNode.)
Protected methodDeserializeReadOnlyProperty T 
Deserializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodDuplicateSubtree T 
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 methodEndRefreshObsolete.
Waits until the currently executing refresh operation is finished.
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.)
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 methodGetRows( DataValueCursor )
Enumerates all rows for the columns specified by the given valueCursors.
Public methodGetRows(IEnumerable Int32 ,  DataValueCursor )
Enumerates a subset of the rows for the columns specified by the given
valueCursors
s.
Protected methodGetService
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.)
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
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnConfigured
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
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
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 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 methodSerializeProperty T (SerializationInfo, StreamingContext, UndoableCrossReferenceProperty T )
Serializes an Undoable*Property with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializeProperty T (SerializationInfo, StreamingContext, UndoableList T )
Serializes an UndoableList with values of type T storing it in info with key list.Name.
(Inherited from DocumentNode.)
Protected methodSerializeProperty T (SerializationInfo, StreamingContext, UndoableProperty T )
Serializes an UndoableProperty with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializeProperty T (SerializationInfo, StreamingContext, UndoableSet T )
Serializes an UndoableSet storing it in info with key given by the property name of the set.
(Inherited from DocumentNode.)
Protected methodSerializeProperty TKey, TValue (SerializationInfo, StreamingContext, UndoableDictionary TKey, TValue )
Serializes an UndoableDictionary storing it in info with key given by the property name of the dictionary.
(Inherited from DocumentNode.)
Protected methodSerializeProperty TKey, TNode (SerializationInfo, StreamingContext, UndoableKeyedCollection TKey, TNode ) (Inherited from DocumentNode.)
Protected methodSerializeReadOnlyProperty T 
Serializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
Back to Top
Properties

  NameDescription
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 propertyIsRefreshable
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 Refresh  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 Refresh ).
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.)
Back to Top
Explicit Interface Implementations

  NameDescription
Explicit interface implemetationPrivate methodIServiceProvider GetService
Implements IServiceProvider.
(Inherited from Node.)
Explicit interface implemetationPrivate methodINodeContext GetAncestor T  (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodINodeContext GetService T  (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodINodeContext IsDescendantOf (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodITransactions BeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodITransactions ExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodITransactions ExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodITransactions ExecuteTransaction (Inherited from DocumentNode.)
Back to Top
See Also