CustomDataSource Class TIBCO Spotfire 7.6 API Reference
Base class for custom data sources. Extend this class to implement a custom data source.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.DataDataSource
    Spotfire.Dxp.Application.ExtensionCustomDataSource

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 CustomDataSource : DataSource

The CustomDataSource type exposes the following members.

Constructors

  NameDescription
Protected methodCustomDataSource
Initializes a new instance of the CustomDataSource class.
Protected methodCustomDataSource(SerializationInfo, StreamingContext)
Implements ISerializable.
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.)
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.
(Inherited from DataSource.)
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 methodSupportsWebPromptingCore
Override this method to indicate whether the data source supports prompting using a web UI.
(Inherited from DataSource.)
Top
Properties

  NameDescription
Public propertyDocumentTitle
Gets a document title for the data returned from this data source with the current configuration.
(Inherited from DataSource.)
Public propertyIsLinkable
Gets a value indicating whether this instance supports linked data mode.
(Inherited from DataSource.)
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