DataFunctionOutputCollection Class

Spotfire 15.0 API Reference

Represents the declarations on how to handle the results for OutputParameters in a DataFunction.

Inheritance Hierarchy

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

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(6, 0)]
public sealed class DataFunctionOutputCollection : DocumentNode, 
	IEnumerable<DataFunctionOutput>, IEnumerable

The DataFunctionOutputCollection 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 DataFunctionOutput for the outputParameter.
	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 DataFunctionOutput for the outputParameter.
	SetColumnsOutput(OutputParameter, ColumnsOutputBuilder)	Sets the output to add columns to a DataTable for the outputParameter.
	SetColumnsOutput(OutputParameter, DataTable)	Sets the output to add columns to a DataTable for the outputParameter.
	SetDataColumnPropertyOutput	Sets the output to a update a DataColumn DataProperty for the outputParameter. If the property is not present it will be created.
	SetDataTablePropertyOutput	Sets the output to a update a DataTable DataProperty for the outputParameter. If the property is not present it will be created.
	SetDocumentPropertyOutput	Sets the output to a update a document DataProperty for the outputParameter. If the property is not present it will be created.
	SetJoinOutput(OutputParameter, JoinOutputBuilder)	Sets the output to join columns to a DataTable for the outputParameter.
	SetJoinOutput(OutputParameter, DataTable, JoinType)	Sets the output to join columns to a DataTable for the outputParameter.
	SetPropertyOutput	Sets the output to a update a DataProperty for the outputParameter. If the property is not present it will be created.
	SetReplaceDataOutput(OutputParameter, ReplaceDataOutputBuilder)	Sets the output to replace data in a new DataTable for the outputParameter.
	SetReplaceDataOutput(OutputParameter, DataTable)	Sets the output to replace data in a new DataTable for the outputParameter.
	SetRowsOutput(OutputParameter, RowsOutputBuilder)	Sets the output to adding rows for the outputParameter.
	SetRowsOutput(OutputParameter, DataTable)	Sets the output to adding rows for the outputParameter. Matching will occur automatically.
	SetTableOutput(OutputParameter, TableOutputBuilder)	Sets the output to create a new DataTable for the outputParameter.
	SetTableOutput(OutputParameter, String)	Sets the output to create a new DataTable for the outputParameter.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetValue	Tries to get a DataFunctionOutput for the outputParameter.

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

Spotfire.Dxp.Data.DataFunctionsDataFunctionOutput

Spotfire.Dxp.Data.DataFunctionsDataFunction