DataConnectionDialog Class

Provides access to the Data Connection dialog box with which to obtain data connection information from users.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.DataConnectionDialog

Namespace:  Microsoft.VisualStudio.Data
Assembly:  Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

声明
Public MustInherit Class DataConnectionDialog _
    Implements IDisposable
public abstract class DataConnectionDialog : IDisposable
public ref class DataConnectionDialog abstract : IDisposable
[<AbstractClass>]
type DataConnectionDialog =  
    class
        interface IDisposable
    end
public abstract class DataConnectionDialog implements IDisposable

The DataConnectionDialog type exposes the following members.

Constructors

  Name Description
Protected method DataConnectionDialog Class constructor.

Top

Properties

  Name Description
Public property AcceptButtonText Retrieves or sets the text displayed on the button the user clicks to accept the contents of the Data Connection dialog box, then returns from the ShowDialog method.
Public property AvailableProviders Retrieves a collection of unique identifiers for DDEX providers that are currently available for selection in the Data Connection dialog box.
Public property AvailableSources A collection of GUIDs representing DDEX data sources that should be available for display in the Data Connection dialog box.
Public property ChangeDataSourceHeaderLabel Retrieves or sets a summary description appearing on the Data Source dialog box header when the user clicks on the Change... button.
Public property ChangeDataSourceTitle Retrieves or sets the title of the Data Source dialog box, which can be shown when the user clicks the Change… button.
Public property ChooseDataSourceAcceptText Retrieves or sets text that shows on the Data Source dialog box Accept button when it appears before the Data Connection dialog box.
Public property ChooseDataSourceHeaderLabel Retrieves or sets text of the description that appears on the header of the Data Source dialog box when it appears before the Data Connection dialog box.
Public property ChooseDataSourceTitle Retrieves or sets the title of the Data Source dialog box when it appears before the Data Connection dialog box.
Public property DisplayConnectionString Retrieves or sets unencrypted connection information for display on the Data Connection dialog box for the specified data provider.
Public property EncryptedConnectionString Retrieves or sets encrypted connection information for the dialog box for the specified data provider.
Public property HeaderLabel Retrieves or sets a summary description that appears at the head of the Data Connection dialog box.
Public property SaveSelection Retrieves or sets a value indicating whether the caller of the dialog box should persist the currently selected data source and DDEX provider combination.
Public property SelectedProvider Retrieves or sets the data provider currently selected in the connection dialog box, using the data provider's GUID.
Public property SelectedSource Retrieves or sets a GUID value indicating the current selected data source.
Public property Title Retrieves or sets the string representing text shown on the connection dialog box title bar.

Top

Methods

  Name Description
Public method AddAllSources Adds all registered data sources for display on the Data Source dialog box.
Public method AddSources(Guid) Enumerates through all registered data sources and associated data providers, and adds those that have a matching provider technology.
Public method AddSources(DataConnectionDialogFilterCallback) Enumerates all registered data sources and their associated data providers, and conditionally adds source/provider combinations to the Data Connection dialog box based on logic in the supplied callback.
Public method Dispose() Disposes of the current instance of the data connection dialog and releases managed resources.
Protected method Dispose(Boolean) Disposes of the current instance of the data connection dialog and releases managed resources.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the DataConnectionDialog object is reclaimed by garbage collection. (Overrides Object.Finalize().)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method LoadExistingConfiguration Configures the Data Connection dialog box with the specified existing DDEX provider and connection string, deriving the correct data source where possible.
Public method LoadProviderSelections Loads information about which DDEX provider is selected by default for each data source.
Public method LoadSourceSelection Loads information about which data source is currently selected.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnVerifySettings Raises the VerifySettings event.
Public method SaveProviderSelections Saves information about which DDEX provider is selected by default for each data source.
Public method SaveSourceSelection Saves information about which data source is currently selected.
Public method ShowDialog() Shows the Data Connection dialog box with the selected data provider and connection string settings pre-populated.
Public method ShowDialog(Boolean) Shows the Data Connection dialog box pre-populated with the data provider and connection string settings and returns an open connection based on the connection string settings.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event VerifySettings The event raised when a user attempts to accept the connection settings in the Data Connection dialog box.

Top

Fields

  Name Description
Public fieldStatic member UnspecifiedSource Represents an unspecified data source.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Data Namespace

DataConnectionDialogFactory

IDisposable