DataConnectionUIControl Class

Enables a custom user interface (UI) control for editing connection properties on the Data Connection dialog box.

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

Syntax

'Declaration
Public Class DataConnectionUIControl _
    Inherits UserControl _
    Implements IDataConnectionUIControl
'Usage
Dim instance As DataConnectionUIControl
public class DataConnectionUIControl : UserControl, 
    IDataConnectionUIControl
public ref class DataConnectionUIControl : public UserControl, 
    IDataConnectionUIControl
public class DataConnectionUIControl extends UserControl implements IDataConnectionUIControl

Remarks

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

Unlike the Initialize class, however, 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 DataConnectionUIControlclass.

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 derived class can hook into the ConnectionProperties event to invoke custom behavior when this method is called. Then, whenever the contents of the connection UI Control need to be updated, the LoadProperties method is called. A derived class should update all their controls with the data currently stored in the ConnectionProperties 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.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 Namespace