IVsDataConnectionDialog Interface

 

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

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

public interface class IVsDataConnectionDialog : IDisposable

NameDescription
System_CAPS_pubpropertyAcceptButtonText

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.

System_CAPS_pubpropertyAvailableProviders

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

System_CAPS_pubpropertyAvailableSources

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

System_CAPS_pubpropertyChangeSourceHeaderLabel

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

System_CAPS_pubpropertyChangeSourceTitle

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

System_CAPS_pubpropertyChooseSourceAcceptText

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.

System_CAPS_pubpropertyChooseSourceHeaderLabel

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.

System_CAPS_pubpropertyChooseSourceTitle

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

System_CAPS_pubpropertyCreateNewConnection

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

System_CAPS_pubpropertyDisplayConnectionString

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

System_CAPS_pubpropertyEncryptedConnectionString

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

System_CAPS_pubpropertyHeaderLabel

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

System_CAPS_pubpropertySafeConnectionString

Gets or sets the connection string that excludes sensitive data.

System_CAPS_pubpropertySaveSelection

Gets or sets a value indicating whether the caller of the dialog box should persist the currently selected data source and DDEX provider combination.

System_CAPS_pubpropertySelectedProvider

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

System_CAPS_pubpropertySelectedSource

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

System_CAPS_pubpropertyTitle

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

System_CAPS_pubpropertyUnspecifiedSource

Gets a GUID representing an unspecified data source.

NameDescription
System_CAPS_pubmethodAddAllSources()

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

System_CAPS_pubmethodAddSources(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.

System_CAPS_pubmethodAddSources(Guid)

Enumerates through all registered data sources and associated data providers, and adds those that have a matching provider technology.

System_CAPS_pubmethodDispose()

(Inherited from IDisposable.)

System_CAPS_pubmethodLoadExistingConfiguration(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.

System_CAPS_pubmethodLoadProviderSelections()

Loads information about which DDEX provider is selected by default for each data source.

System_CAPS_pubmethodLoadSourceSelection()

Loads information about which data source is currently selected.

System_CAPS_pubmethodSaveProviderSelections()

Saves information about which DDEX provider is selected by default for each data source.

System_CAPS_pubmethodSaveSourceSelection()

Saves information about which data source is currently selected.

System_CAPS_pubmethodShowDialog()

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

System_CAPS_pubmethodShowDialog(Boolean)

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

NameDescription
System_CAPS_pubeventVerifyConfiguration

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

This interface is implemented as a built-in DDEX service.

Return to top
Show: