HyperLinkDataBindingHandler.DataBindControl(IDesignerHost, Control) Method

Reference

Definition

Namespace:: System.Web.UI.Design

Assembly:: System.Design.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Resolves design-time data-binding for the specified control.

public:
 override void DataBindControl(System::ComponentModel::Design::IDesignerHost ^ designerHost, System::Web::UI::Control ^ control);

public override void DataBindControl(System.ComponentModel.Design.IDesignerHost designerHost, System.Web.UI.Control control);

override this.DataBindControl : System.ComponentModel.Design.IDesignerHost * System.Web.UI.Control -> unit

Public Overrides Sub DataBindControl (designerHost As IDesignerHost, control As Control)

Parameters

designerHost: IDesignerHost

The IDesignerHost for the document that contains the control.

control: Control

The Control to data bind.

Examples

The following code example creates a class, named CustomHyperLinkDataBindingHandler, which derives from the HyperLinkDataBindingHandler class. It resolves design-time data binding for the ImageUrl property of the CustomHyperLink class so that placeholder text is displayed for the property when it is data-bound at design time.

// Derive a class from the HyperLinkDataBindingHandler. It will 
// resolve  data binding for the CustomHyperlink at design time.
public class CustomHyperLinkDataBindingHandler : 
    HyperLinkDataBindingHandler
{
    // Override the DataBindControl to set property values in  
    // the DataBindingCollection at design time.
    public override void DataBindControl(IDesignerHost designerHost, 
        Control control)
    {
        DataBindingCollection bindings = 
            ((IDataBindingsAccessor)control).DataBindings;
        DataBinding imageBinding = bindings["ImageUrl"];

           // If Text is empty, supply a default value.
        if (!(imageBinding == null))
        {
            CustomHyperLink hype = (CustomHyperLink)control;
            hype.ImageUrl = "Image URL.";
        }

        // Call the base method to bind the control.
        base.DataBindControl(designerHost, control);
    } // DataBindControl
} // CustomHyperLinkDataBindingHandler

' Derive a class from the HyperLinkDataBindingHandler. It will 
' resolve  data binding for the CustomHyperlink at design time.
Public Class CustomHyperLinkDataBindingHandler
    Inherits HyperLinkDataBindingHandler

    ' Override the DataBindControl to set property values in  
    ' the DataBindingCollection at design time.
    Public Overrides Sub DataBindControl( _
        ByVal designerHost As IDesignerHost, ByVal control As Control)

        Dim bindings As DataBindingCollection = _
            CType(control, IDataBindingsAccessor).DataBindings
        Dim imageBinding As DataBinding = bindings("ImageUrl")

        If Not (imageBinding Is Nothing) Then
            Dim hLink As CustomHyperLink = CType(control, CustomHyperLink)
            hLink.ImageUrl = "Image URL."
        End If

        MyBase.DataBindControl(designerHost, control)
    End Sub
End Class

Remarks

This method determines whether the Text and NavigateUrl properties of the HyperLink control are data-bound. If the Text property is data-bound, this method sets the value of the property to "DataBound". If the NavigateUrl property is data-bound, this method sets the value of the property to a text string so the control will have the appearance of a working hyperlink.

Applies to

Product	Versions
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

AI Skills Fest

Share via