IVsDataConnectionDialog Members

Include Protected Members
Include Inherited Members

Provides access to the Add Connection dialog box, with which you can obtain data connection information from users.

The IVsDataConnectionDialog type exposes the following members.

Methods

 

Name

Description

Public method

AddAllSources

Adds all registered data sources for display in the Choose/Change Data Source dialog box.

Public method

AddSources

Overloaded. Enumerates all registered data sources and their associated data providers, and conditionally adds source/provider combinations to the Add Connection dialog box.

Public method

Dispose

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)

Public method

LoadExistingConfiguration

Configures the Add Connection dialog box with the specified existing DDEX provider and connection string, deriving the correct data source when 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.

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

Overloaded. Shows the Add Connection dialog box pre-populated with the data provider and connection string settings.

Top

Properties

 

Name

Description

Public property

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.

Public property

AvailableProviders

Gets a collection of unique identifiers for DDEX providers that are currently available for selection in the Choose/Change Data Source dialog box.

Public property

AvailableSources

A collection of GUIDs representing DDEX data sources that should be available for display in the Choose/Change Data Source dialog box.

Public property

ChangeSourceHeaderLabel

Gets or sets a summary description appearing on the Change Data Source dialog box header when the user clicks the Change button.

Public property

ChangeSourceTitle

Gets or sets the title of the Change Data Source dialog box, which can be shown when the user clicks the Change button.

Public property

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.

Public property

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.

Public property

ChooseSourceTitle

Gets or sets the title of the Choose Data Source dialog box when it appears before the Add Connection dialog box.

Public property

CreateNewConnection

Gets or sets a Boolean value indicating whether a new connection should be created.

Public property

DisplayConnectionString

Gets or sets unencrypted connection information for display in the Add Connection dialog box for the specified data provider.

Public property

EncryptedConnectionString

Gets or sets encrypted connection information for the dialog box for the specified data provider.

Public property

HeaderLabel

Gets or sets a summary description that appears in the header of the Add Connection dialog box.

Public property

SafeConnectionString

Gets or sets the connection string that excludes sensitive data.

Public property

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.

Public property

SelectedProvider

Gets or sets the data provider currently selected in the connection dialog box, using the data provider's GUID.

Public property

SelectedSource

Gets or sets a GUID value indicating the current selected data source.

Public property

Title

Gets or sets the string representing the text shown in the connection dialog box title bar.

Public property

UnspecifiedSource

Gets a GUID representing an unspecified data source.

Top

Events

 

Name

Description

Public event

VerifyConfiguration

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

Top

See Also

Reference

IVsDataConnectionDialog Interface

Microsoft.VisualStudio.Data.Services Namespace