DataFunctionInputCollection.SetInput Method (InputParameter, String, Boolean, DataSelection[])

DataFunctionInputCollection SetInput Method (InputParameter, String, Boolean, DataSelection )

TIBCO Spotfire 6.0 API Reference

Sets the DataFunctionInput for an InputParameter using an expression representing a list of column expressions. The value is calculate on the intersection of all the input selections.

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

Syntax

C++

Copy to Clipboard Print

public DataFunctionInput SetInput(
	InputParameter inputParameter,
	string expression,
	bool includeActiveFiltering,
	params DataSelection[] selections
)

public DataFunctionInput SetInput(
	InputParameter inputParameter,
	string expression,
	bool includeActiveFiltering,
	params DataSelection[] selections
)

Parameters

inputParameter: Type: Spotfire.Dxp.Data.DataFunctions InputParameter
The input parameter.

expression: Type: System String
The expression that defines the input. This is comma separated list of column expressions with qualified table names that may only refer to one single table.

includeActiveFiltering: Type: System Boolean
A value indicating whether the active filtering be included in the selections or not.

selections: Type: Spotfire.Dxp.Data DataSelection
The selections that define which rows to use to calculate the expression result. If multiple selections are sent as input then they will resulting rows will be the rows that are included in all the selections.

Return Value

Type: DataFunctionInput
The newly created input.