.NET Framework Class Library
ToolboxDataAttribute Class

Specifies the default tag generated for a custom control when it is dragged from a toolbox in a tool such as Microsoft Visual Studio.

Inheritance Hierarchy

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)
<[%$TOPIC/k5fhy58t_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/k5fhy58t_en-us_VS_110_2_0_0_0_1%].Class)> _
Public NotInheritable Class ToolboxDataAttribute _
	Inherits [%$TOPIC/k5fhy58t_en-us_VS_110_2_0_0_0_2%]
public sealed class ToolboxDataAttribute : [%$TOPIC/k5fhy58t_en-us_VS_110_2_0_1_0_2%]
public ref class ToolboxDataAttribute sealed : public [%$TOPIC/k5fhy58t_en-us_VS_110_2_0_2_0_2%]
type ToolboxDataAttribute =  
        inherit [%$TOPIC/k5fhy58t_en-us_VS_110_2_0_3_0_3%] 
public final class ToolboxDataAttribute extends [%$TOPIC/k5fhy58t_en-us_VS_110_2_0_4_0_0%]

The ToolboxDataAttribute type exposes the following members.

Public method ToolboxDataAttributeInfrastructure. Initializes a new instance of the ToolboxDataAttribute class.
Public property DataGets the string representing the initial values of the control's property, which is used in a visual designer for creating an instance of the control.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public method EqualsInfrastructure. Tests whether the ToolboxDataAttribute object is equal to the given object. (Overrides AttributeEquals(Object).)
Public method GetHashCodeReturns the hash code of the custom control. (Overrides AttributeGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeInfrastructure. Tests whether the ToolboxDataAttribute object contains the default value for the Data property. (Overrides AttributeIsDefaultAttribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Public field Static member DefaultRepresents the default ToolboxDataAttribute value for a custom control.
Explicit Interface Implementations
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)

By default, the visual designer of a tool such as Visual Studio, creates an empty tag. This is a tag representing a control in its default state, when the control is dropped from the toolbox of a visual designer onto the design surface. To specify initial default values, a control can make use of this attribute. You can use this attribute to customize the initial HTML content that is placed in the designer when the control is dragged from the toolbox onto the form.

[ ToolboxData("<{0}:MyLabel runat= server Text= 
       MyLabel><{0}:MyLabel>") ]public class MyLabel : Label {...}

In the following code example, the previous code sets several properties specific to MyLabel. All occurrences of {0} are replaced, by the designer, with the tag prefix associated with the MyLabel class.

Imports System
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls

Namespace CustomControls
  <ToolboxData("<{0}:MyLabel Text='MyLabel' BorderColor='Yellow' BackColor='Magenta' BorderWidth = '10'  runat='server'></{0}:MyLabel>")>  _
  Public Class MyLabel
    Inherits Label

    Public Sub New()
      'Your code goes here. 
    End Sub 'New 

  End Class 'MyLabel

End Namespace 'CustomControls
using System;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace CustomControls

  [ ToolboxData("<{0}:MyLabel Text='MyLabel' BorderColor='Yellow' BackColor='Magenta' BorderWidth = '10'  runat='server'></{0}:MyLabel>") ]	
  public class MyLabel : Label 
    public  MyLabel()
      // Your code goes here.

Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 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.