DataConnectionDialog Class

Definition

Namespace:

Microsoft.VisualStudio.Data

Assembly:

Microsoft.VisualStudio.Data.dll

Package:

Microsoft.VisualStudio.Data v17.10.40170

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

public ref class DataConnectionDialog abstract : IDisposable

public abstract class DataConnectionDialog : IDisposable

type DataConnectionDialog = class
    interface IDisposable

Public MustInherit Class DataConnectionDialog
Implements IDisposable

Inheritance

Object

DataConnectionDialog

Implements

IDisposable

Constructors

DataConnectionDialog()

Class constructor.

Fields

UnspecifiedSource

Represents an unspecified data source.

Properties

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.
AvailableProviders	Retrieves a collection of unique identifiers for DDEX providers that are currently available for selection in the Data Connection dialog box.
AvailableSources	A collection of GUIDs representing DDEX data sources that should be available for display in the Data Connection dialog box.
ChangeDataSourceHeaderLabel	Retrieves or sets a summary description appearing on the Data Source dialog box header when the user clicks on the Change... button.
ChangeDataSourceTitle	Retrieves or sets the title of the Data Source dialog box, which can be shown when the user clicks the Change… button.
ChooseDataSourceAcceptText	Retrieves or sets text that shows on the Data Source dialog box Accept button when it appears before the Data Connection dialog box.
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.
ChooseDataSourceTitle	Retrieves or sets the title of the Data Source dialog box when it appears before the Data Connection dialog box.
DisplayConnectionString	Retrieves or sets unencrypted connection information for display on the Data Connection dialog box for the specified data provider.
EncryptedConnectionString	Retrieves or sets encrypted connection information for the dialog box for the specified data provider.
HeaderLabel	Retrieves or sets a summary description that appears at the head of the Data Connection dialog box.
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.
SelectedProvider	Retrieves or sets the data provider currently selected in the connection dialog box, using the data provider's GUID.
SelectedSource	Retrieves or sets a GUID value indicating the current selected data source.
Title	Retrieves or sets the string representing text shown on the connection dialog box title bar.

Methods

AddAllSources()	Adds all registered data sources for display on the Data Source dialog box.
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.
AddSources(Guid)	Enumerates through all registered data sources and associated data providers, and adds those that have a matching provider technology.
Dispose()	Disposes of the current instance of the data connection dialog and releases managed resources.
Dispose(Boolean)	Disposes of the current instance of the data connection dialog and releases managed resources.
Finalize()	Releases unmanaged resources and performs other cleanup operations before the DataConnectionDialog object is reclaimed by garbage collection.
LoadExistingConfiguration(Guid, String, Boolean)	Configures the Data Connection dialog box with the specified existing DDEX provider and connection string, deriving the correct data source where possible.
LoadProviderSelections()	Loads information about which DDEX provider is selected by default for each data source.
LoadSourceSelection()	Loads information about which data source is currently selected.
OnVerifySettings(EventArgs)	Raises the VerifySettings event.
SaveProviderSelections()	Saves information about which DDEX provider is selected by default for each data source.
SaveSourceSelection()	Saves information about which data source is currently selected.
ShowDialog()	Shows the Data Connection dialog box with the selected data provider and connection string settings pre-populated.
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.

Events

VerifySettings

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