.NET Framework Class Library
DesignerAttribute Class

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

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModelDesignerAttribute

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/e9926eyd_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/e9926eyd_en-us_VS_110_2_0_0_0_1%].Class Or [%$TOPIC/e9926eyd_en-us_VS_110_2_0_0_0_2%].Interface, AllowMultiple := True,  _
	Inherited := True)> _
Public NotInheritable Class DesignerAttribute _
	Inherits [%$TOPIC/e9926eyd_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/e9926eyd_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/e9926eyd_en-us_VS_110_2_0_1_0_1%].Class|[%$TOPIC/e9926eyd_en-us_VS_110_2_0_1_0_2%].Interface, AllowMultiple = true, 
	Inherited = true)]
public sealed class DesignerAttribute : [%$TOPIC/e9926eyd_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/e9926eyd_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/e9926eyd_en-us_VS_110_2_0_2_0_1%]::Class|[%$TOPIC/e9926eyd_en-us_VS_110_2_0_2_0_2%]::Interface, AllowMultiple = true, 
	Inherited = true)]
public ref class DesignerAttribute sealed : public [%$TOPIC/e9926eyd_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/e9926eyd_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/e9926eyd_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/e9926eyd_en-us_VS_110_2_0_3_0_2%].Class|[%$TOPIC/e9926eyd_en-us_VS_110_2_0_3_0_3%].Interface, AllowMultiple = true, 
    Inherited = true)>]
type DesignerAttribute =  
    class 
        inherit [%$TOPIC/e9926eyd_en-us_VS_110_2_0_3_0_4%] 
    end

The DesignerAttribute type exposes the following members.

Constructors
  NameDescription
Public method DesignerAttribute(String)Initializes a new instance of the DesignerAttribute class using the name of the type that provides design-time services.
Public method DesignerAttribute(Type)Initializes a new instance of the DesignerAttribute class using the type that provides design-time services.
Public method DesignerAttribute(String, String)Initializes a new instance of the DesignerAttribute class using the designer type and the base class for the designer.
Public method 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.
Public method DesignerAttribute(Type, Type)Initializes a new instance of the DesignerAttribute class using the types of the designer and designer base class.
Top
Properties
  NameDescription
Public property DesignerBaseTypeNameGets the name of the base type of this designer.
Public property DesignerTypeNameGets the name of the designer type associated with this designer attribute.
Public property TypeIdGets a unique ID for this attribute type. (Overrides AttributeTypeId.)
Top
Methods
  NameDescription
Public method EqualsReturns whether the value of the given object is equal to the current DesignerAttribute. (Overrides AttributeEquals(Object).)
Public method GetHashCodeReturns the hash code for this instance. (Overrides AttributeGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
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.)
Top
Explicit Interface Implementations
  NameDescription
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.)
Top
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 Extending Metadata Using Attributes.

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.

<Designer("System.Windows.Forms.Design.DocumentDesigner, System.Windows.Forms.Design.DLL", _
    GetType(IRootDesigner)), DesignerCategory("Form")> _
Public Class MyForm

    Inherits ContainerControl
    ' Insert code here. 
End Class 'MyForm
[Designer("System.Windows.Forms.Design.DocumentDesigner, System.Windows.Forms.Design.DLL", 
    typeof(IRootDesigner)),
    DesignerCategory("Form")]
public class MyForm : ContainerControl {
    // Insert code here.
}
[Designer("System.Windows.Forms.Design.DocumentDesigner, System.Windows.Forms.Design.DLL",
IRootDesigner::typeid),
DesignerCategory("Form")]
ref class MyForm: public 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 Shared Function Main() As Integer 
    ' Creates a new form. 
    Dim myNewForm As New MyForm()

    ' Gets the attributes for the collection. 
    Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(myNewForm)

    ' Prints the name of the designer by retrieving the DesignerAttribute 
    ' from the AttributeCollection.  
    Dim myAttribute As DesignerAttribute = _
        CType(attributes(GetType(DesignerAttribute)), DesignerAttribute)
    Console.WriteLine(("The designer for this class is: " & myAttribute.DesignerTypeName))

    Return 0
End Function 'Main
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;
}
int main()
{
   // Creates a new form.
   MyForm^ myNewForm = gcnew 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 = dynamic_cast<DesignerAttribute^>(attributes[ DesignerAttribute::typeid ]);
   Console::WriteLine( "The designer for this class is: {0}", myAttribute->DesignerTypeName );
   return 0;
}
Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

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.

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.