CalculationCollection Class

Spotfire 14.5 API Reference

A collection of calculation instances.

Inheritance Hierarchy

System.Object
  Node
    Spotfire.Dxp.Framework.DocumentModel.DocumentNode
      Spotfire.Dxp.Framework.DocumentModel.DocumentNodeListBase<Calculation>
        Spotfire.Dxp.Application.Calculations.CalculationCollection

Namespace: Spotfire.Dxp.Application.Calculations
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 67.0.20819.4186 (67.0.20819.4186)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(2, 0)]
public sealed class CalculationCollection : DocumentNodeListBase<Calculation>, 
	IServiceProvider

The CalculationCollection type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	Gets the number of elements contained in this instance. (Inherited from DocumentNodeListBase<T>.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Item	Gets the element at the specified index. (Inherited from DocumentNodeListBase<T>.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	AddNew(TypeIdentifier)	Adds a new instance of the calculation identified by typeId to this collection.
	AddNew<TCalculation>()	Adds a new instance of the given calculation type to this collection.
	Contains(String)	Determine if the collection contains the Calculation instance identified by calculationName
	Contains(T)	Determines whether the specified value is in this collection. (Inherited from DocumentNodeListBase<T>.)
	FindCalculations(Type)	Finds all Calculations of type calculationType
	FindCalculations(TypeIdentifier)	Finds all Calculations with TypeIdentifiertypeId.
	FindCalculations<TCalculation>()	Finds all calculations of type TCalculation
	ForEachNodeInSubTree<TNode>	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	Returns an enumerator that iterates through this collection. (Inherited from DocumentNodeListBase<T>.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Searches for the specified value and returns the zero-based index of the first occurrence within this collection. (Inherited from DocumentNodeListBase<T>.)
	Remove	Completely removes the execution and all its results such as tables or columns.
	ToArray	Copies the elements of the collection to a new array. (Inherited from DocumentNodeListBase<T>.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetCalculation	Tries to get a Calculation instance by name.

Top

Extension Methods

	Name	Description
	GetService<TService>	Convenience generic extension method that calls GetService(Type) and casts the result. (Defined by Extensions.)

Top

Explicit Interface Implementations

	Name	Description
	IEnumerable.GetEnumerator	Returns an enumerator that iterates through a collection. (Inherited from DocumentNodeListBase<T>.)
	INodeContext.GetAncestor<T>	Implements GetAncestor<T>(). (Inherited from DocumentNode.)
	INodeContext.GetService<T>	Implements GetService<T>(). (Inherited from DocumentNode.)
	INodeContext.IsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactions.BeginAggregatedTransaction	Implements BeginAggregatedTransaction(). (Inherited from DocumentNode.)
	ITransactions.ExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactions.ExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactions.ExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Version Information

Supported in: 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

Reference

Spotfire.Dxp.Application.Calculations Namespace