DataFlow Class

Spotfire 14.2 API Reference

Represents a flow of data from the DataSource through an ordered set of DataTransformation's.

Inheritance Hierarchy

SystemObject
Spotfire.Dxp.DataDataSource
Spotfire.Dxp.DataDataFlow

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

Syntax

[SerializableAttribute]
[PersistenceVersionAttribute(29, 0)]
public sealed class DataFlow : DataSource, 
	IEquatable<DataFlow>

The DataFlow type exposes the following members.

Properties

	Name	Description
	DataSource	Gets a copy of the DataSource that this flow is based on.
	IsPromptingAllowed	Gets or sets a value indicating whether prompting is allowed is allowed for this data source instance. (Inherited from DataSource.)
	LoadReport	Gets the PartialDataLoadReport that can be used to report errors during connection. (Inherited from DataSource.)
	Name	Gets the display name of the data source. Same as the document title by default. (Inherited from DataSource.)
	ReuseSettingsWithoutPrompting	Gets or sets a value indicating whether settings should be reused without prompting or not. Determines if the data source should be opened in silent mode, prompting the user only when necessary, or if the user should get a chance to modify the settings even if they are valid. (Inherited from DataSource.)
	Transformations	Get a read-only copy of the list of DataTransformation's.
	TypeId	Gets the type identifier for the data source. (Inherited from DataSource.)

Methods

	Name	Description
	Connect	Creates a DataSourceConnection, using the specified serviceProvider and the settings in this data source instance. If needed, and allowed by the current prompt mode, the user may be prompted for additional settings. (Inherited from DataSource.)
	ConnectWithDelayedPrompting	Creates a DataSourceConnection, using the specified serviceProvider and the settings in this data source instance. If needed, and allowed by the current prompt mode, the user may be prompted for additional settings. (Inherited from DataSource.)
	Equals(Object)	Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object).)
	Equals(DataFlow)	Indicates whether the current object is equal to another object of the same type.
	GetHashCode	Serves as the default hash function. (Overrides ObjectGetHashCode.)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object. (Overrides DataSourceGetObjectData(SerializationInfo, StreamingContext).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Remarks

This class is immutable with no public constructor; use a DataFlowBuilder to create an instance of this class.

Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4