Base class for custom file data sources. Extend this class to implement a custom
file data source.
Inheritance Hierarchy
Spotfire.Dxp.DataDataSource
Spotfire.Dxp.Data.ImportFileDataSource
Spotfire.Dxp.Application.ExtensionCustomFileDataSource
Namespace: Spotfire.Dxp.Application.Extension
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(2, 0)] public abstract class CustomFileDataSource : FileDataSource
The CustomFileDataSource type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CustomFileDataSource |
Initializes a new instance of the CustomFileDataSource class.
|
| CustomFileDataSource(SerializationInfo, StreamingContext) | Implements ISerializable. |
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.) |
| 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.
(Inherited from FileDataSource.) |
| 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.
(Inherited from FileDataSource.) |
| SupportsWebPromptingCore |
Override this method to indicate whether the data source supports prompting using a web UI.
(Inherited from DataSource.) |
Properties
| Name | Description | |
|---|---|---|
 | DataOriginIsStream |
Gets a value indicating whether the data origin is a stream.
(Inherited from FileDataSource.) |
| DocumentTitle | Gets a document title for the data returned from this data source with the current configuration.
(Inherited from DataSource.) |
| FilePath |
Gets or sets the file path.
(Inherited from FileDataSource.) |
| IsLinkable |
Gets a value indicating whether this instance supports linked data mode.
(Inherited from FileDataSource.) |
| 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.) |
Version Information
See Also