DesignerAttribute Class

Definition

Namespace:

System.ComponentModel

Assemblies:

netstandard.dll, System.ComponentModel.Primitives.dll

Source:

DesignerAttribute.cs

Specifies the class used to implement design-time services for a component.

C#

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface, AllowMultiple=true, Inherited=true)]
public sealed class DesignerAttribute : Attribute

Inheritance

Object

Attribute

DesignerAttribute

Attributes

AttributeUsageAttribute

Examples

The following example creates a class called MyForm. MyForm has two attributes, a DesignerAttribute that specifies this class uses the DocumentDesigner, and a DesignerCategoryAttribute that specifies the Form category.

C#

[Designer("System.Windows.Forms.Design.DocumentDesigner, System.Windows.Forms.Design.DLL", 
    typeof(IRootDesigner)),
    DesignerCategory("Form")]
public class MyForm : ContainerControl {
    // Insert code here.
}

The next example creates an instance of MyForm. Then it gets the attributes for the class, extracts the DesignerAttribute, and prints the name of the designer.

C#

public static int Main() {
    // Creates a new form.
    MyForm myNewForm = new MyForm();
 
    // Gets the attributes for the collection.
    AttributeCollection attributes = TypeDescriptor.GetAttributes(myNewForm);
 
    /* Prints the name of the designer by retrieving the DesignerAttribute
     * from the AttributeCollection. */
    DesignerAttribute myAttribute = 
       (DesignerAttribute)attributes[typeof(DesignerAttribute)];
    Console.WriteLine("The designer for this class is: " + myAttribute.DesignerTypeName);
  
    return 0;
}

Remarks

The class you use for the design-time services must implement the IDesigner interface.

Use the DesignerBaseTypeName property to find the designer's base type. Use the DesignerTypeName property to get the name of the type of designer associated with this member.

For more information, see Attributes.

Constructors

DesignerAttribute(String, String)	Initializes a new instance of the DesignerAttribute class using the designer type and the base class for the designer.
DesignerAttribute(String, Type)	Initializes a new instance of the DesignerAttribute class, using the name of the designer class and the base class for the designer.
DesignerAttribute(String)	Initializes a new instance of the DesignerAttribute class using the name of the type that provides design-time services.
DesignerAttribute(Type, Type)	Initializes a new instance of the DesignerAttribute class using the types of the designer and designer base class.
DesignerAttribute(Type)	Initializes a new instance of the DesignerAttribute class using the type that provides design-time services.

Properties

DesignerBaseTypeName	Gets the name of the base type of this designer.
DesignerTypeName	Gets the name of the designer type associated with this designer attribute.
TypeId	Gets a unique ID for this attribute type.

Methods

Equals(Object)	Returns whether the value of the given object is equal to the current DesignerAttribute.
GetHashCode()	Returns the hash code for this instance.
GetType()	Gets the Type of the current instance. (Inherited from Object)
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)
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)

Applies to

See also

• Attribute