DataColumnCollection Class

Spotfire 14.3 API Reference

This is a collection of DataColumn columns in a DataTable. This class is used to retrieve columns and to add new columns.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.DataDataColumnCollection

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(4, 0)]
public sealed class DataColumnCollection : DocumentNode, 
	IEnumerable<DataColumn>, IEnumerable

The DataColumnCollection type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	Gets the number of columns in the collection.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	ItemInt32	Get a column with a given index.
	ItemString	Get a column with the given name.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	AddCalculatedColumn	Add a new calculated column.
	AddHierarchyColumn	Add a new hierarchy column.
	AddTagsColumn	Add a new tags column.
	Contains	Check if this collection contains a column with the given name.
	CreateUniqueName	Create a new unique column name from a suggestion. The suggested name is used if possible.
	FindAll(String)	Find all columns which matches the given search pattern. For search syntax see Spotfire user manual.
	FindAll(PredicateDataColumn)	Find all columns satisfying the Predicate.
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsValidName	Check if the suggested column name is a valid unique name in the collection.
	Remove(IEnumerableString)	Remove the columns with the given names.
	Remove(String)	Remove the column with the given name.
	Remove(DataColumn)	Remove the column from this collection.
	Remove(IEnumerableDataColumn)	Remove columns from this collection.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetValue	Try to get a column with a given name.

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection.
	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