IVsDataConnectionDialog Interface

Definition

Namespace:

Microsoft.VisualStudio.Data.Services

Assembly:

Microsoft.VisualStudio.Data.Services.dll

Package:

Microsoft.VisualStudio.Data.Services v17.10.40170

Represents a dialog that can manipulate data connection properties through provider specified UI controls and/or a property grid.

public interface class IVsDataConnectionDialog : IDisposable

public interface IVsDataConnectionDialog : IDisposable

type IVsDataConnectionDialog = interface
    interface IDisposable

Public Interface IVsDataConnectionDialog
Implements IDisposable

Implements

IDisposable

Properties

AcceptButtonText	Gets or sets the text displayed on the button the user clicks to accept the contents of the Add Connection dialog box, and then returns from the ShowDialog() method.
AvailableProviders	Gets a collection of unique identifiers for DDEX providers that are currently available for selection in the Choose/Change Data Source dialog box.
AvailableSources	A collection of GUIDs representing DDEX data sources that should be available for display in the Choose/Change Data Source dialog box.
ChangeSourceHeaderLabel	Gets or sets a summary description appearing on the Change Data Source dialog box header when the user clicks the Change button.
ChangeSourceTitle	Gets or sets the title of the Change Data Source dialog box, which can be shown when the user clicks the Change button.
ChooseSourceAcceptText	Gets or sets text that appears on the Continue button of the Choose Data Source dialog box when it appears before the Add Connection dialog box.
ChooseSourceHeaderLabel	Gets or sets the text of the description that appears on the header of the Choose Data Source dialog box when it appears before the Add Connection dialog box.
ChooseSourceTitle	Gets or sets the title of the Choose Data Source dialog box when it appears before the Add Connection dialog box.
CreateNewConnection	Gets or sets a Boolean value indicating whether a new connection should be created.
DisplayConnectionString	Gets or sets unencrypted connection information for display in the Add Connection dialog box for the specified data provider.
EncryptedConnectionString	Gets or sets encrypted connection information for the dialog box for the specified data provider.
HeaderLabel	Gets or sets a summary description that appears in the header of the Add Connection dialog box.
SafeConnectionString	Gets or sets the connection string that excludes sensitive data.
SaveSelection	Gets or sets a value indicating whether the caller of the dialog box should persist the currently selected data source and DDEX provider combination.
SelectedProvider	Gets or sets the data provider currently selected in the connection dialog box, using the data provider's GUID.
SelectedSource	Gets or sets a GUID value indicating the current selected data source.
Title	Gets or sets the string representing the text shown in the connection dialog box title bar.
UnspecifiedSource	Gets a GUID representing an unspecified data source.

Methods

AddAllSources()	Adds all registered data sources for display in the Choose/Change Data Source dialog box.
AddSources(DataConnectionDialogFilterCallback)	Enumerates all registered data sources and their associated data providers, and conditionally adds source/provider combinations to the Choose/Change Data Source dialog box, depending 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.
LoadExistingConfiguration(Guid, String, Boolean)	Configures the Add Connection dialog box with the specified existing DDEX provider and connection string, deriving the correct data source when 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.
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 Add Connection dialog box pre-populated with the data provider and connection string settings.
ShowDialog(Boolean)	Shows the Add Connection dialog box pre-populated with the data provider and connection string settings.

Events

VerifyConfiguration

Occurs when the OK button is clicked in the Add Connection dialog box. Clients can use this event to perform configuration checking.