DataConnectionUIControl Class

Enables a custom UI control for editing connection properties in the Data Connection dialog box.

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

Syntax

Public Class DataConnectionUIControl _
    Inherits UserControl _
    Implements IVsDataConnectionUIControl, IVsDataSiteableObject(Of IVsDataConnectionUIProperties),  _
    IVsDataSiteableObject(Of IServiceProvider)

Dim instance As DataConnectionUIControl
public class DataConnectionUIControl : UserControl, IVsDataConnectionUIControl, 
    IVsDataSiteableObject<IVsDataConnectionUIProperties>, IVsDataSiteableObject<IServiceProvider>
public ref class DataConnectionUIControl : public UserControl, 
    IVsDataConnectionUIControl, IVsDataSiteableObject<IVsDataConnectionUIProperties^>, IVsDataSiteableObject<IServiceProvider^>
public class DataConnectionUIControl extends UserControl implements IVsDataConnectionUIControl, IVsDataSiteableObject<IVsDataConnectionUIProperties>, IVsDataSiteableObject<IServiceProvider>

Remarks

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

The DataConnectionUIControl class 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.

A derived class 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.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Windows.Forms.Control
        System.Windows.Forms.ScrollableControl
          System.Windows.Forms.ContainerControl
            System.Windows.Forms.UserControl
              Microsoft.VisualStudio.Data.Framework.DataConnectionUIControl

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

DataConnectionUIControl Members

Microsoft.VisualStudio.Data.Framework Namespace