SummaryTableVisibleColumnCollection Class

Spotfire 15.0 API Reference

Collection of columns used in the plot. This collection contains the columns visible in a SummaryTable. The collection is synchronized with changes in the underlying data, such as remove, add and rename of columns.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsSummaryTableVisibleColumnCollection

Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 71.0.22122.5390 (71.0.22122.5390)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(2, 0)]
public sealed class SummaryTableVisibleColumnCollection : DocumentNode, 
	IEnumerable<SummaryTableVisibleColumn>, IEnumerable

The SummaryTableVisibleColumnCollection type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	Gets the number of SummaryTableVisibleColumns in the collection.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	ItemInt32	Returns the SummaryTableVisibleColumn at the given index.
	ItemString	Returns the SummaryTableVisibleColumn for the data column named columnName.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	AddNew	Add an existing data column by name.
	Clear	Clears the collection.
	Contains(String)	Checks if columnName is contained in this collection.
	Contains(SummaryTableVisibleColumn)	Determines whether this SummaryTableVisibleColumnCollection contains the specified column.
	ForEachNodeInSubTreeTNode	Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node. (Inherited from DocumentNode.)
	GetEnumerator	Gets an enumerator.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Returns the index in the collection that the column has.
	Move	Move the item at fromIndex to toIndex where both indexes are prior to any insertion and removal operations.
	Remove(String)	Removes the column named columnName from the collection if it exists.
	Remove(SummaryTableVisibleColumn)	Removes a column from the collection.
	RemoveAt	Remove the SummaryTableVisibleColumn located at index.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

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

Reference

Spotfire.Dxp.Application.Visuals Namespace