IVsDataConnectionUIControl Interface

Represents the interface that exposes methods and properties that enable a custom user interface (UI) control for editing connection properties in the Data Connection dialog box.

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

Syntax

'Declaration
Public Interface IVsDataConnectionUIControl _
    Inherits IVsDataSiteableObject(Of IVsDataConnectionUIProperties)

public interface IVsDataConnectionUIControl : IVsDataSiteableObject<IVsDataConnectionUIProperties>

public interface class IVsDataConnectionUIControl : IVsDataSiteableObject<IVsDataConnectionUIProperties^>

type IVsDataConnectionUIControl =  
    interface 
        interface IVsDataSiteableObject<IVsDataConnectionUIProperties>
    end

public interface IVsDataConnectionUIControl extends IVsDataSiteableObject<IVsDataConnectionUIProperties>

The IVsDataConnectionUIControl type exposes the following members.

Properties

	Name	Description
	Control	When implemented by a class, gets the current user control as a UserControl object.
	Site	Gets or sets the site. (Inherited from IVsDataSiteableObject<T>.)

Top

Methods

	Name	Description
	LoadProperties	When implemented by a class, loads the properties of controls in the Data Connection dialog box, such as the data source, user ID, password, and initial catalog.

Top

Remarks

Use this interface to support graphical representation of connection information, as in the Visual Studio Data Connection dialog box, which is implemented by using the DataConnectionProperties class.

The DataConnectionUIControl class, which inherits this interface, provides a completely customized UI, and provides implementers of DDEX providers with the maximum degree of flexibility. No specialized UI is available unless you implement the DataConnectionUIControl class.

When the Visual Studio Data Connection dialog box first creates a DDEX provider's connection UI control, it calls the Initialize method with an instance of the provider's connection properties implementation.

A class derived from DataConnectionUIControl can use the SiteChanged event to invoke custom behavior when this event is raised. Then, whenever the contents of the connection UI control need to be updated, the LoadProperties method is called. A derived class should update all of its controls with the data currently stored in the Site object.

This interface has a base implementation in the DDEX Framework.

See Also

Reference

Microsoft.VisualStudio.Data.Services.SupportEntities Namespace