DataBindingHandlerAttribute Class
 

Specifies a design-time class that performs data binding of controls within a designer. This class cannot be inherited.

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Web.UIDataBindingHandlerAttribute

Syntax
[AttributeUsageAttribute(AttributeTargets.Class)]
public sealed class DataBindingHandlerAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class)]
public ref class DataBindingHandlerAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class)>]
type DataBindingHandlerAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Class)>
Public NotInheritable Class DataBindingHandlerAttribute
	Inherits Attribute
Constructors
NameDescription
System_CAPS_pubmethod DataBindingHandlerAttribute

Initializes a new instance of the DataBindingHandlerAttribute class using no parameters. This is the default constructor.

System_CAPS_pubmethod DataBindingHandlerAttribute

Initializes a new instance of the DataBindingHandlerAttribute class with the specified type name.

System_CAPS_pubmethod DataBindingHandlerAttribute

Initializes a new instance of the DataBindingHandlerAttribute class of the specified Type.

Properties
NameDescription
System_CAPS_pubproperty

Gets the type name of the data-binding handler.

System_CAPS_pubproperty

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

Methods
NameDescription
System_CAPS_pubmethod Equals

This API supports the product infrastructure and is not intended to be used directly from your code. Determines whether two object instances are equal.(Overrides AttributeEquals.)

System_CAPS_pubmethod GetHashCode

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the hash code for this instance.(Overrides AttributeGetHashCode.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod IsDefaultAttribute

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)

System_CAPS_pubmethod Match

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

Fields
NameDescription
System_CAPS_pubfield System_CAPS_static Default

Defines the default attribute for the DataBindingHandlerAttribute class.

Explicit Interface Implementations
NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

Remarks

For more information about using attributes, see Extending Metadata Using Attributes.

Examples

The following code example defines a data-binding handler, named MyDataBindingHandler, to be used by the designer in editing mode. On exiting the editing mode, the Text property value is displayed.


using System;
using System.Collections;
using System.Web.UI;
using System.Web.UI.Design;
using System.Web.UI.WebControls;
using System.ComponentModel;
using System.ComponentModel.Design;


namespace CustomControls
{
  [
    DataBindingHandler(typeof(MyDataBindingHandler)),
    ToolboxData("<{0}:MyLabel runat=server></{0}:MyLabel>")
  ]
  public class MyLabel : Label 
  {
    public  MyLabel()
    { 
      // Insert your code here.
    } 
  }

  public class MyDataBindingHandler : DataBindingHandler
  {
    public override void DataBindControl(IDesignerHost host, Control control)
    {
      ((Label)control).Text = "Added by data binding handler.";
    }
  }

}

Namespace CustomControls

  <DataBindingHandler(GetType(MyDataBindingHandler)), ToolboxData("<{0}:MyLabel runat=server></{0}:MyLabel>")>  _
    Public Class MyLabel
      Inherits Label

      Public Sub New()
        'Insert your code here.
      End Sub 'NewNew

    End Class 'MyLabel

    Public Class MyDataBindingHandler
      Inherits DataBindingHandler

      Public Overrides Sub DataBindControl(host As IDesignerHost, control As Control)
         CType(control, Label).Text = "Added by data binding handler."
      End Sub 'DataBindControl

    End Class 'MyDataBindingHandler

End Namespace 'CustomControls 
Version Information
.NET Framework
Available since 1.1
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.

Return to top