TableSortInfoCollection Class

Spotfire 14.2 API Reference

Contains info on how to sort the table plot.

Inheritance Hierarchy

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

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(4, 0)]
public sealed class TableSortInfoCollection : DocumentNode, 
	IEnumerable<TableSortInfo>, IEnumerable

The TableSortInfoCollection type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	The number of items in the collection.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	Add	Adds a column that will be used to sort the table plot after.
	Clear	Removes all items in the collection.
	Contains	Determines if a column is present in the collection.
	GetEnumerator	Gets an enumerator over the items in the collection.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Remove	Removes a data column from the colleciton.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetSortInfo	Gets the sort info corresponding to a given data column if it exists.

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

Remarks

An empty collection corresponds to an unsorted table plot. As elements are added they are considered in the order that they exist in this collection.

Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4

Reference

Spotfire.Dxp.Application.Visuals Namespace