DataSourceOperationReplaceDataFlow Method

Spotfire 14.3 API Reference
Replaces the current data flow with the supplied DataFlow.

Namespace:  Spotfire.Dxp.Data.DataOperations
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax

C#
public void ReplaceDataFlow(
	DataFlow dataFlow
)

Parameters

dataFlow
Type: Spotfire.Dxp.DataDataFlow
The new data flow.
Exceptions

ExceptionCondition
InvalidOperationExceptionThrown if replacing the data flow is not possible.
Remarks

Before calling this method, validate that CanReplaceDataFlow returns true.

Note that replacing the data flow resets the data loading behavior. The reason is that not all DataLoadingBehavior settings are applicable to all types of data flows.

The data operation will be refreshed synchronously.

If only transformations are to be replaced, use ReplaceTransformations(IEnumerableDataTransformation) instead, since that method doesn't reset the data loading behavior.

It is not possible to replace with a data flow where the supplied DataSource is a DataTableDataSource.

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference