DataFunctionInputCollection Class

Spotfire 14.7 API Reference

Represents the declarations on how to retrieve the values for InputParameters in a DataFunction.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Data.DataFunctionsDataFunctionInputCollection

Namespace: Spotfire.Dxp.Data.DataFunctions
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 69.0.21424.2902 (69.0.21424.2902)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(52, 0)]
public sealed class DataFunctionInputCollection : DocumentNode, 
	IEnumerable<DataFunctionInput>, IEnumerable

The DataFunctionInputCollection type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	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
	ContainsKey	Check if there is a DataFunctionInput for the given InputParameter.
	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	Returns an enumerator that iterates through the collection.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Remove	Removes the DataFunctionInput for the given InputParameter.
	SetInput(InputParameter, ActionDataViewDefinition)	Sets the DataFunctionInput for an InputParameter using a ActionDataViewDefinition instance.
	SetInput(InputParameter, String)	Sets the DataFunctionInput for an InputParameter using an expression representing a list of column expressions. The value is calculated on all rows in the input.
	SetInput(InputParameter, String, DataSelection)	Sets the DataFunctionInput for an InputParameter using an expression representing a list of column expressions. The value is calculated on the intersection of all the input selections.
	SetInput(InputParameter, String, Boolean, DataSelection)	Sets the DataFunctionInput for an InputParameter using an expression representing a list of column expressions. The value is calculated on the intersection of all the input selections.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetValue	Tries to get a DataFunctionInput for the given InputParameter.

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.7, 14.6, 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.Data.DataFunctions Namespace

Spotfire.Dxp.Data.DataFunctionsDataFunctionInput

Spotfire.Dxp.Data.DataFunctionsDataFunction