DataSourceConnection Class

Spotfire 14.3 API Reference
Represents an open connection to a data source.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.DataDataSourceConnection

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

C#
public abstract class DataSourceConnection : IDisposable

The DataSourceConnection type exposes the following members.

Constructors

  NameDescription
Protected methodDataSourceConnection
Initializes a new instance of the DataSourceConnection class.
Top
Properties

  NameDescription
Public propertyConnectedUserName
Gets or sets the name of the connected user.
Public propertyDataSource
Gets the data source.
Public propertyDocumentTitle
Gets a document title for the data returned from this data source with the current configuration.
Public propertyHasUserDependentData
Gets or sets a value indicating whether the data depends on the current user or not.
Public propertyIsLinkable
Gets a value indicating whether this instance supports linked data mode.
Public propertyServiceProvider
Gets access to services.
Top
Methods

  NameDescription
Public methodClose
Synonym for Dispose.
Public methodStatic memberCreateConnection2(DataSource, QueryExecutor2, IServiceProvider)
Creates a default DataSourceConnection instance.
Public methodStatic memberCreateConnection2(DataSource, QueryExecutor2, IServiceProvider, IEnumerableObject)
Creates a default DataSourceConnection instance.
Public methodDispose
Disposes of the connection.
Protected methodDispose(Boolean)
Disposes of the connection.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecuteQuery2
Executes the query with the current data source settings and returns the resulting DataRowReader.
Protected methodExecuteQueryCore2
Executes the query with the current data source settings and returns the resulting DataRowReader.
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.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPromptModels
Get an enumeration of the prompt models that should be used for prompting.
Protected methodGetPromptModelsCore
This method is used to provide the prompt models that should be used for the data source.
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.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
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

Reference