DataColumn Class

Spotfire 14.3 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: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(59, 0)]
public sealed class DataColumn : DocumentNode, 
	IDataColumn

The DataColumn type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	DataType	Gets the data type.
	DisplayValueSettings	Gets the display value settings for this column.
	Hierarchy	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.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	IsValid	Gets a value indicating whether the column is valid or not.
	Name	Gets or sets the name of the column.
	NameEscapedForExpression	Gets the name of the column escaped for usage in an expression. This is a utility method which uses EscapeIdentifier(String).
	Properties	Gets the properties (metadata) of the column.
	RowValues	Gets the row values for the column.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	Visible	Gets or sets a value indicating whether this column should be visible in the user interface.

Top

Methods

	Name	Description
	AsT	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.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a String that represents the current Object. (Overrides ObjectToString.)

Top

Explicit Interface Implementations

	Name	Description
	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.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

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

Reference

Spotfire.Dxp.Data Namespace