DesignerAttribute Class
 

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

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModelDesignerAttribute

Syntax
[AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Interface, 
	AllowMultiple = true, Inherited = true)]
public sealed class DesignerAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class | AttributeTargets::Interface, 
	AllowMultiple = true, Inherited = true)]
public ref class DesignerAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Interface,
    AllowMultiple = true, Inherited = true)>]
type DesignerAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Interface,
	AllowMultiple := True, Inherited := True)>
Public NotInheritable Class DesignerAttribute
	Inherits Attribute
Constructors
NameDescription
System_CAPS_pubmethod DesignerAttribute

Initializes a new instance of the DesignerAttribute class using the name of the type that provides design-time services.

System_CAPS_pubmethod DesignerAttribute

Initializes a new instance of the DesignerAttribute class using the designer type and the base class for the designer.

System_CAPS_pubmethod DesignerAttribute

Initializes a new instance of the DesignerAttribute class, using the name of the designer class and the base class for the designer.

System_CAPS_pubmethod DesignerAttribute

Initializes a new instance of the DesignerAttribute class using the type that provides design-time services.

System_CAPS_pubmethod DesignerAttribute

Initializes a new instance of the DesignerAttribute class using the types of the designer and designer base class.

Properties
NameDescription
System_CAPS_pubproperty

Gets the name of the base type of this designer.

System_CAPS_pubproperty

Gets the name of the designer type associated with this designer attribute.

System_CAPS_pubproperty

Gets a unique ID for this attribute type.(Overrides .)

Methods
NameDescription
System_CAPS_pubmethod Equals

Returns whether the value of the given object is equal to the current DesignerAttribute.(Overrides AttributeEquals.)

System_CAPS_pubmethod GetHashCode

Returns the hash code for this instance.(Overrides AttributeGetHashCode.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod 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.)

System_CAPS_pubmethod Match

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

Explicit Interface Implementations
NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

Remarks

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

Use the property to find the designer's base type. Use the 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", 
    typeof(IRootDesigner)),
    DesignerCategory("Form")]
public class MyForm : ContainerControl {
    // Insert code here.
}
<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",
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 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;
}
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
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
Available since 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.

Return to top