FileDataSource Class

Spotfire 14.3 API Reference

Abstract base class for file data sources.

Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.DataDataSource
    Spotfire.Dxp.Data.ImportFileDataSource
      Spotfire.Dxp.Application.ExtensionCustomFileDataSource
      Spotfire.Dxp.Data.ImportSbdfFileDataSource
      Spotfire.Dxp.Data.ImportStdfFileDataSource
      Spotfire.Dxp.Data.ImportTextFileDataSource

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(56, 0)]
public abstract class FileDataSource : DataSource

The FileDataSource type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	DataOriginIsStream	Gets a value indicating whether the data origin is a stream.
	FilePath	Gets or sets the file path.
	IsLinkable	Gets a value indicating whether this instance supports linked data mode. (Overrides DataSourceIsLinkable.)
	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.)
	TypeId	Gets the type identifier for the data source. (Inherited from DataSource.)

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. (Inherited from DataSource.)
	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. (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.)
	CreateTempFile	Creates a temp file from the given stream. The file is stored in a dedicated temp directory, and is automatically deleted at a scheduled time.
	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. (Overrides DataSourceGenerateDataHistoryCore(DataHistoryBuilder).)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object. (Overrides DataSourceGetObjectData(SerializationInfo, StreamingContext).)
	GetServiceT	Convenience method to fetch a service for inheritors. (Inherited from DataSource.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OpenFileStream	Creates a new file stream to be used for a new reader.
	SupportsWebPromptingCore	Override this method to indicate whether the data source supports prompting using a web UI. (Inherited from DataSource.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

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.Import Namespace