.NET Framework Class Library
DesignerCategoryAttribute Class

Specifies that the designer for a class belongs to a certain category.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModelDesignerCategoryAttribute

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/y8a962xs_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/y8a962xs_en-us_VS_110_2_0_0_0_1%].Class, AllowMultiple := False, Inherited := True)> _
Public NotInheritable Class DesignerCategoryAttribute _
	Inherits [%$TOPIC/y8a962xs_en-us_VS_110_2_0_0_0_2%]
[[%$TOPIC/y8a962xs_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/y8a962xs_en-us_VS_110_2_0_1_0_1%].Class, AllowMultiple = false, Inherited = true)]
public sealed class DesignerCategoryAttribute : [%$TOPIC/y8a962xs_en-us_VS_110_2_0_1_0_2%]
[[%$TOPIC/y8a962xs_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/y8a962xs_en-us_VS_110_2_0_2_0_1%]::Class, AllowMultiple = false, Inherited = true)]
public ref class DesignerCategoryAttribute sealed : public [%$TOPIC/y8a962xs_en-us_VS_110_2_0_2_0_2%]
[<[%$TOPIC/y8a962xs_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/y8a962xs_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/y8a962xs_en-us_VS_110_2_0_3_0_2%].Class, AllowMultiple = false, Inherited = true)>]
type DesignerCategoryAttribute =  
    class 
        inherit [%$TOPIC/y8a962xs_en-us_VS_110_2_0_3_0_3%] 
    end
public final class DesignerCategoryAttribute extends [%$TOPIC/y8a962xs_en-us_VS_110_2_0_4_0_0%]

The DesignerCategoryAttribute type exposes the following members.

Constructors
  NameDescription
Public method Supported by the XNA Framework DesignerCategoryAttributeInitializes a new instance of the DesignerCategoryAttribute class with an empty string ("").
Public method Supported by the XNA Framework DesignerCategoryAttribute(String)Initializes a new instance of the DesignerCategoryAttribute class with the given category name.
Top
Properties
  NameDescription
Public property Supported by the XNA Framework CategoryGets the name of the category.
Public property TypeIdInfrastructure. Gets a unique identifier for this attribute. (Overrides AttributeTypeId.)
Top
Methods
  NameDescription
Public method Supported by the XNA Framework EqualsInfrastructure. Returns whether the value of the given object is equal to the current DesignOnlyAttribute. (Overrides AttributeEquals(Object).)
Public method Supported by the XNA Framework GetHashCodeInfrastructure. Returns the hash code for this instance. (Overrides AttributeGetHashCode.)
Public method Supported by the XNA Framework GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeInfrastructure. Determines if this attribute is the default. (Overrides AttributeIsDefaultAttribute.)
Public method Supported by the XNA Framework MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method Supported by the XNA Framework ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Fields
  NameDescription
Public field Static member Supported by the XNA Framework ComponentSpecifies that a component marked with this category use a component designer. This field is read-only.
Public field Static member Supported by the XNA Framework DefaultInfrastructure. Specifies that a component marked with this category cannot use a visual designer. This static field is read-only.
Public field Static member Supported by the XNA Framework FormSpecifies that a component marked with this category use a form designer. This static field is read-only.
Public field Static member Supported by the XNA Framework GenericSpecifies that a component marked with this category use a generic designer. This static field is read-only.
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

A visual designer can use a designer category to inform a development environment of the type of designer that will be implemented. If no designer category is provided on a class, a development environment may or may not allow the class to be designed. A category can be created for any name.

When you mark a class with this attribute, it is set to a constant member. When you want to check the value of this attribute in your code, you must specify the constant member. The Description column in the table below lists the constant member that each value is set to.

The DesignerCategoryAttribute class defines the following common categories:

Category

Description

Component

Designers that are used with components. The attribute is set to the constant member DesignerCategoryAttributeComponent.

Form

Designers that are used with forms. The attribute is set to the constant member DesignerCategoryAttributeForm.

Designer

Designers that are used with designers. The attribute is set to the constant member DesignerCategoryAttributeGeneric.

Empty String ("")

This is the default category.

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", _
    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", 
    typeof(IRootDesigner)),
    DesignerCategory("Form")]

 public class MyForm : ContainerControl {
    // Insert code here.
 }
[Designer("System.Windows.Forms.Design.DocumentDesigner, System.Windows.Forms.Design",
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 DesignerCategoryAttribute, 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 
    ' DesignerCategoryAttribute from the AttributeCollection.  
    Dim myAttribute As DesignerCategoryAttribute = _
        CType(attributes(GetType(DesignerCategoryAttribute)), DesignerCategoryAttribute)
    Console.WriteLine(("The category of the designer for this class is: " + myAttribute.Category))
    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 
     * DesignerCategoryAttribute from the AttributeCollection. */
    DesignerCategoryAttribute myAttribute = 
       (DesignerCategoryAttribute)attributes[typeof(DesignerCategoryAttribute)];
    Console.WriteLine("The category of the designer for this class is: " + myAttribute.Category);

    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 
       * DesignerCategoryAttribute from the AttributeCollection. */
   DesignerCategoryAttribute^ myAttribute = dynamic_cast<DesignerCategoryAttribute^>(attributes[ DesignerCategoryAttribute::typeid ]);
   Console::WriteLine( "The category of the designer for this class is: {0}", myAttribute->Category );
   return 0;
}
Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0
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.