DataColumn Class

 Spotfire 14.7 API Reference
This is a data column which is part of a data table and can be used to retrieve data on row values, hierarchies and properties. The data column implements the IDataColumn which is to be used for non-modification operations on the data column. This class has no public constructors, see the DataColumnCollection class for methods which create data columns.
Inheritance Hierarchy
SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.DataDataColumn

Namespace:  Spotfire.Dxp.Data
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 69.0.21424.2902 (69.0.21424.2902)
Syntax
C#
Copy
[SerializableAttribute]
[PersistenceVersionAttribute(59, 0)]
public sealed class DataColumn : DocumentNode, 
	IDataColumn

The DataColumn type exposes the following members.

Properties
  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyDataType
Gets the data type.
Public propertyDisplayValueSettings
Gets the display value settings for this column.
Public propertyHierarchy
Gets the hierarchy of the column, this is either the hierarchy in the case of a hierarchy column or the indexed column for other columns.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyIsValid
Gets a value indicating whether the column is valid or not.
Public propertyName
Gets or sets the name of the column.
Public propertyNameEscapedForExpression
Gets the name of the column escaped for usage in an expression. This is a utility method which uses EscapeIdentifier(String).
Public propertyProperties
Gets the properties (metadata) of the column.
Public propertyRowValues
Gets the row values for the column.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyVisible
Gets or sets a value indicating whether this column should be visible in the user interface.
Top
Methods
  NameDescription
Public methodAsT
Gets a representation of the DataColumn for modification of properties that are not part of a standard DataColumn. If this is a calculated column then the CalculatedColumn class can be retrieved from this method. If this is a tags column then the TagsColumn class can be retrieved and if this is a hierarchy column then the HierarchyColumn class can be retrieved. If this is a result column then the ResultColumn class can be retrieved. The classes which can be retrieved will be extended in the future.
Public methodForEachNodeInSubTreeTNode
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
(Inherited from DocumentNode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current Object.
(Overrides ObjectToString.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodINodeContextGetAncestorT
Implements GetAncestorT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT
Implements GetServiceT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
Version Information

Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference

Spotfire.Dxp.Data Namespace