This topic has not yet been rated - Rate this topic

DesignerCategoryAttribute Class

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

System.Object
  System.Attribute
    System.ComponentModel.DesignerCategoryAttribute

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)
'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := False, Inherited := True)> _
Public NotInheritable Class DesignerCategoryAttribute _
	Inherits Attribute

The DesignerCategoryAttribute type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkDesignerCategoryAttributeInitializes a new instance of the DesignerCategoryAttribute class with an empty string ("").
Public methodSupported by the XNA FrameworkDesignerCategoryAttribute(String)Initializes a new instance of the DesignerCategoryAttribute class with the given category name.
Top
  NameDescription
Public propertySupported by the XNA FrameworkCategoryGets the name of the category.
Public propertyTypeIdInfrastructure. Gets a unique identifier for this attribute. (Overrides Attribute.TypeId.)
Top
  NameDescription
Public methodSupported by the XNA FrameworkEqualsInfrastructure. Returns whether the value of the given object is equal to the current DesignOnlyAttribute. (Overrides Attribute.Equals(Object).)
Public methodSupported by the XNA FrameworkGetHashCodeInfrastructure. Returns the hash code for this instance. (Overrides Attribute.GetHashCode.)
Public methodSupported by the XNA FrameworkGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeInfrastructure. Determines if this attribute is the default. (Overrides Attribute.IsDefaultAttribute.)
Public methodSupported by the XNA FrameworkMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodSupported by the XNA FrameworkToStringReturns a string that represents the current object. (Inherited from Object.)
Top
  NameDescription
Public fieldStatic memberSupported by the XNA FrameworkComponentSpecifies that a component marked with this category use a component designer. This field is read-only.
Public fieldStatic memberSupported by the XNA FrameworkDefaultInfrastructure. Specifies that a component marked with this category cannot use a visual designer. This static field is read-only.
Public fieldStatic memberSupported by the XNA FrameworkFormSpecifies that a component marked with this category use a form designer. This static field is read-only.
Public fieldStatic memberSupported by the XNA FrameworkGenericSpecifies that a component marked with this category use a generic designer. This static field is read-only.
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

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 DesignerCategoryAttribute.Component.

Form

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

Designer

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

Empty String ("")

This is the default category.

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", _
    GetType(IRootDesigner)), DesignerCategory("Form")> _
Public Class MyForm

    Inherits ContainerControl
    ' Insert code here. 
End Class 'MyForm

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

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