Export (0) Print
Expand All

CategoryAttribute Class

Specifies the name of the category in which to group the property or event when displayed in a PropertyGrid control set to Categorized mode.

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

[AttributeUsageAttribute(AttributeTargets.All)] 
public class CategoryAttribute : Attribute
/** @attribute AttributeUsageAttribute(AttributeTargets.All) */ 
public class CategoryAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.All) 
public class CategoryAttribute extends Attribute
Not applicable.

A CategoryAttribute indicates the category to associate the associated property or event with, when listing properties or events in a PropertyGrid control set to Categorized mode. If a CategoryAttribute has not been applied to a property or event, the PropertyGrid associates it with the Misc category. A new category can be created for any name by specifying the name of the category in the constructor for the CategoryAttribute.

The Category property indicates the name of the category that the attribute represents. The Category property also provides transparent localization of category names.

Notes to Inheritors: If you use category names other than the predefined names, and you want to localize your category names, you must override the GetLocalizedString method. Additionally, you can override the Category property to provide your own logic for localization. The CategoryAttribute class defines the following common categories:

Category

Description

Action

Properties related to available actions.

Appearance

Properties related to how an entity appears.

Behavior

Properties related to how an entity acts.

Data

Properties related to data and data source management.

Default

Properties that are grouped in a default category.

Design

Properties that are available only at design time.

DragDrop

Properties related to drag-and-drop operations.

Focus

Properties related to focus.

Format

Properties related to formatting.

Key

Properties related to the keyboard.

Layout

Properties related to layout.

Mouse

Properties related to the mouse.

WindowStyle

Properties related to the window style of top-level forms.

For more information, see Attributes Overview and Extending Metadata Using Attributes.

The following example creates the MyImage property. The property has two attributes: a DescriptionAttribute and a CategoryAttribute.

[Description("The image associated with the control"),Category("Appearance")] 
 public Image MyImage {
    get {
       // Insert code here.
       return image1;
    }
    set {
       // Insert code here.
    }
 }

/** @attribute Description("The image associated with the control")
  * @attribute Category("Appearance")
 */
/** @property 
 */
public Image get_MyImage()
{
    // Insert code here.
    return image1;
} //get_MyImage

/** @property 
 */
public void set_MyImage(Image value)
{
    // Insert code here.
} //set_MyImage

The next example gets the category for MyImage. First, the code gets a PropertyDescriptorCollection with all the properties for the object. Next, the code indexes into the PropertyDescriptorCollection to get MyImage. Then it returns the attributes for this property and saves them in the variable attributes.

The example then prints the category by retrieving CategoryAttribute from the AttributeCollection, and writing it to the console screen.

// Gets the attributes for the property.
 AttributeCollection attributes = 
    TypeDescriptor.GetProperties(this)["MyImage"].Attributes;
 
 // Prints the description by retrieving the CategoryAttribute.
 // from the AttributeCollection.
 CategoryAttribute myAttribute = 
    (CategoryAttribute)attributes[typeof(CategoryAttribute)];
 Console.WriteLine(myAttribute.Category);

// Gets the attributes for the property.
AttributeCollection attributes = TypeDescriptor.GetProperties(this)
    .get_Item("MyImage").get_Attributes();

// Prints the description by retrieving the CategoryAttribute.
// from the AttributeCollection.
CategoryAttribute myAttribute = (CategoryAttribute)(
    attributes.get_Item(CategoryAttribute.class.ToType()));
Console.WriteLine(myAttribute.get_Category());

System.Object
   System.Attribute
    System.ComponentModel.CategoryAttribute

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft