Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

DesignerAttribute Class

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

System.Object
  System.Attribute
    System.ComponentModel.DesignerAttribute

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Interface, AllowMultiple = true, 
	Inherited = true)]
public sealed class DesignerAttribute : Attribute

The DesignerAttribute type exposes the following members.

  NameDescription
Public methodDesignerAttribute(String)Initializes a new instance of the DesignerAttribute class using the name of the type that provides design-time services.
Public methodDesignerAttribute(Type)Initializes a new instance of the DesignerAttribute class using the type that provides design-time services.
Public methodDesignerAttribute(String, String)Initializes a new instance of the DesignerAttribute class using the designer type and the base class for the designer.
Public methodDesignerAttribute(String, Type)Initializes a new instance of the DesignerAttribute class, using the name of the designer class and the base class for the designer.
Public methodDesignerAttribute(Type, Type)Initializes a new instance of the DesignerAttribute class using the types of the designer and designer base class.
Top
  NameDescription
Public propertyDesignerBaseTypeNameGets the name of the base type of this designer.
Public propertyDesignerTypeNameGets the name of the designer type associated with this designer attribute.
Public propertyTypeIdGets a unique ID for this attribute type. (Overrides Attribute.TypeId.)
Top
  NameDescription
Public methodEqualsReturns whether the value of the given object is equal to the current DesignerAttribute. (Overrides Attribute.Equals(Object).)
Public methodGetHashCodeReturns the hash code for this instance. (Overrides Attribute.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top
  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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 Extending Metadata Using Attributes.

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.

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

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

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.