DataSource Class

TIBCO Spotfire 11.8 API Reference
Abstract class for data sources. Used when loading and saving linked data.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.DataDataSource
    More...

Namespace:  Spotfire.Dxp.Data
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 55.0.17008.5965 (55.0.17008.5965)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(2, 0)]
public abstract class DataSource : ISerializable

The DataSource type exposes the following members.

Constructors

  NameDescription
Protected methodDataSource
Initializes a new instance of the DataSource class.
Top
Properties

  NameDescription
Public propertyDocumentTitle
Gets a document title for the data returned from this data source with the current configuration.
Public propertyIsLinkable
Gets a value indicating whether this instance supports linked data mode.
Public propertyIsPromptingAllowed
Gets or sets a value indicating whether prompting is allowed is allowed for this data source instance.
Public propertyLoadReport
Gets the PartialDataLoadReport that can be used to report errors during connection.
Public propertyName
Gets the display name of the data source. Same as the document title by default.
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.
Public propertyTypeId
Gets the type identifier for the data source.
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.
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.
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.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Populates a SerializationInfo with the data needed to serialize the target object.
Protected methodGetServiceT
Convenience method to fetch a service for inheritors.
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.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

Implementors of this class must be serializable.
Version Information

Supported in: 11.8, 11.7, 11.6, 11.5, 11.4, 11.3, 11.2, 11.1, 11.0, 10.10, 7.11
See Also

Reference

Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.DataDataSource
    Spotfire.Dxp.Application.ExtensionCustomDataSource
    Spotfire.Dxp.DataDataFlow
    Spotfire.Dxp.Data.ImportDatabaseDataSource
    Spotfire.Dxp.Data.ImportDataTableDataSource
    Spotfire.Dxp.Data.ImportFileDataSource
    Spotfire.Dxp.Data.ImportInformationLinkDataSource
    Spotfire.Dxp.Data.ImportSbdfLibraryDataSource