DataSource Class

Spotfire 14.3 API Reference

Abstract class for data sources. Used when loading and saving linked data.

Inheritance Hierarchy

SystemObject
Spotfire.Dxp.DataDataSource
More...

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(2, 0)]
public abstract class DataSource : ISerializable

The DataSource type exposes the following members.

Constructors

	Name	Description
	DataSource	Initializes a new instance of the DataSource class.

Top

Properties

	Name	Description
	DocumentTitle	Gets a document title for the data returned from this data source with the current configuration.
	IsLinkable	Gets a value indicating whether this instance supports linked data mode.
	IsPromptingAllowed	Gets or sets a value indicating whether prompting is allowed is allowed for this data source instance.
	LoadReport	Gets the PartialDataLoadReport that can be used to report errors during connection.
	Name	Gets the display name of the data source. Same as the document title by default.
	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.
	TypeId	Gets the type identifier for the data source.

Top

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.
	ConnectCore	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.
	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.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GenerateDataHistoryCore	Create detail information for the DataSource. See DataHistoryBuilder for more information on how to add detailed information to the data history.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object.
	GetServiceT	Convenience method to fetch a service for inheritors.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SupportsWebPromptingCore	Override this method to indicate whether the data source supports prompting using a web UI.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Implementors of this class must be serializable.

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

Reference

Spotfire.Dxp.Data Namespace

Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.DataDataSource
    Spotfire.Dxp.Application.ExtensionCustomDataSource
    Spotfire.Dxp.DataDataFlow
    Spotfire.Dxp.Data.ImportDatabaseDataSource
    Spotfire.Dxp.Data.ImportDataTableDataSource
    Spotfire.Dxp.Data.ImportFileDataSource
    Spotfire.Dxp.Data.ImportInformationLinkDataSource
    Spotfire.Dxp.Data.ImportSbdfLibraryDataSource