FileDataSource Class TIBCO Spotfire 7.6 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: 25.11.10401.3615 (25.11.10401.3615)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(25, 0)]
public abstract class FileDataSource : DataSource

The FileDataSource type exposes the following members.

Constructors

  NameDescription
Protected methodFileDataSource
Initializes a new instance of the FileDataSource class.
Top
Methods

  NameDescription
Public methodConnect
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.)
Protected methodConnectCore
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.)
Public methodConnectWithDelayedPrompting
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.)
Public methodStatic memberCreateTempFile
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.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGenerateDataHistoryCore
Create detail information for the DataSource. See DataHistoryBuilder for more information on how to add detailed information to the data history.
(Overrides DataSourceGenerateDataHistoryCore(DataHistoryBuilder).)
Protected methodGetServiceT
Convenience method to fetch a service for inheritors.
(Inherited from DataSource.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOpenFileStream
Creates a new file stream to be used for a new reader.
Protected methodSupportsWebPromptingCore
Override this method to indicate whether the data source supports prompting using a web UI.
(Inherited from DataSource.)
Top
Properties

  NameDescription
Public propertyDataOriginIsStream
Gets a value indicating whether the data origin is a stream.
Public propertyDocumentTitle
Gets a document title for the data returned from this data source with the current configuration.
(Inherited from DataSource.)
Public propertyFilePath
Gets or sets the file path.
Public propertyIsLinkable
Gets a value indicating whether this instance supports linked data mode.
(Overrides DataSourceIsLinkable.)
Public propertyIsPromptingAllowed
Gets or sets a value indicating whether prompting is allowed is allowed for this data source instance.
(Inherited from DataSource.)
Public propertyLoadReport
Gets the PartialDataLoadReport that can be used to report errors during connection.
(Inherited from DataSource.)
Public propertyName
Gets the display name of the data source. Same as the document title by default.
(Inherited from DataSource.)
Public propertyReuseSettingsWithoutPrompting
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.)
Public propertyTypeId
Gets the type identifier for the data source.
(Inherited from DataSource.)
Top
Version Information

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference