ToolboxDataAttribute Class

Reference

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.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.

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

public ref class ToolboxDataAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class)]
public sealed class ToolboxDataAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class)>]
type ToolboxDataAttribute = class
    inherit Attribute

Public NotInheritable Class ToolboxDataAttribute
Inherits Attribute

Inheritance: Object

Attribute
ToolboxDataAttribute

Attributes: AttributeUsageAttribute

Examples

[ 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.


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.
    } 
  }
}

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
    
  End Class
  
End Namespace 'CustomControls

Remarks

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.

Constructors

ToolboxDataAttribute(String)

Initializes a new instance of the ToolboxDataAttribute class.

Fields

Default

Represents the default ToolboxDataAttribute value for a custom control.

Properties

Data	Gets 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.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Tests whether the ToolboxDataAttribute object is equal to the given object.
GetHashCode()	Returns the hash code of the custom control.
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	Tests whether the ToolboxDataAttribute object contains the default value for the Data property.
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object. (Inherited from Attribute)

Applies to