DataRelationCollection.Add Method

DataRelationCollection Add Method

TIBCO Spotfire 5.5 API Reference

Adds a relation to this collection.

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

Syntax

C++

Copy to Clipboard Print

public DataRelation Add(
	DataTable leftTable,
	DataTable rightTable,
	string relationExpression
)

public DataRelation Add(
	DataTable leftTable,
	DataTable rightTable,
	string relationExpression
)

Parameters

leftTable: Type: Spotfire.Dxp.Data DataTable
The left table.

rightTable: Type: Spotfire.Dxp.Data DataTable
The right table.

relationExpression: Type: System String
The relation expression.

Return Value

Type: DataRelation
The new data relation.

Exceptions

Exception	Condition
System ArgumentException	Thrown if the relation is not valid.

Remarks

If the expression is F=H and one of the subexpressions, say H, has return type string while the other do not this operation will rewrite the expression so H is casted to F:s datatype. This differs from how other expressions work in dxp as string is not normally implicitly casted to other datatypes but is needed for API-compatibility here.

Version Information

Supported in: 5.5, 5.0, 4.5, 4.0, 3.3