Base class for custom data sources. Extend this class to implement a custom
data source.
Inheritance Hierarchy
Spotfire.Dxp.DataDataSource
Spotfire.Dxp.Application.ExtensionCustomDataSource
Namespace: Spotfire.Dxp.Application.Extension
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(2, 0)] public abstract class CustomDataSource : DataSource
The CustomDataSource type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CustomDataSource |
Initializes a new instance of the CustomDataSource class.
|
| CustomDataSource(SerializationInfo, StreamingContext) | Implements ISerializable. |
Properties
| Name | Description | |
|---|---|---|
 | AlwaysLoadOnApplicationThread |
Gets a value indicating whether this data source always should be loaded on
the application thread. The default value is false.
|
 | DocumentTitle | Gets a document title for the data returned from this data source with the current configuration.
(Inherited from DataSource.) |
| IsLinkable |
Gets a value indicating whether this instance supports linked data mode.
(Inherited from DataSource.) |
| 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.) |
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.) |
| 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.
(Inherited from DataSource.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetObjectData |
Populates a SerializationInfo with the data needed to serialize the target object.
(Inherited from DataSource.) |
| 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.) |
| 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.) |
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
See Also