CategoryAttribute Clase

Definición

Espacio de nombres:

System.ComponentModel

Ensamblado:

System.ComponentModel.Primitives.dll

Source:

CategoryAttribute.cs

Especifica el nombre de la categoría en la que se agrupa la propiedad o el evento cuando se muestra en un control PropertyGrid establecido en el modo Por categorías.

public ref class CategoryAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.All)]
public class CategoryAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.All)>]
type CategoryAttribute = class
    inherit Attribute

Public Class CategoryAttribute
Inherits Attribute

Herencia

Object

Attribute

CategoryAttribute

Atributos

AttributeUsageAttribute

Ejemplos

En el ejemplo siguiente se crea la MyImage propiedad . La propiedad tiene dos atributos: y DescriptionAttribute .CategoryAttribute

   [Description("The image associated with the control"),Category("Appearance")]
   System::Drawing::Image^ get()
   {
      // Insert code here.
      return m_Image1;
   }

   void set( System::Drawing::Image^ )
   {
      // Insert code here.
   }
}

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

<Description("The image associated with the control"), _
    Category("Appearance")> _
Public Property MyImage() As Image
    
    Get
        ' Insert code here.
        Return image1
    End Get
    Set
        ' Insert code here.
    End Set 
End Property

En el ejemplo siguiente se obtiene la categoría de MyImage. En primer lugar, el código obtiene con PropertyDescriptorCollection todas las propiedades del objeto . A continuación, el código se indexa en para PropertyDescriptorCollection obtener MyImage. A continuación, devuelve los atributos de esta propiedad y los guarda en la variable attributes.

A continuación, en el ejemplo se imprime la categoría recuperando CategoryAttribute de AttributeCollectiony escribiendola en la pantalla de la consola.

// 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 = static_cast<CategoryAttribute^>(attributes[ CategoryAttribute::typeid ]);
Console::WriteLine( myAttribute->Category );

// 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.
Dim attributes As AttributeCollection = _
    TypeDescriptor.GetProperties(Me)("MyImage").Attributes

' Prints the description by retrieving the CategoryAttribute. 
' from the AttributeCollection.
Dim myAttribute As CategoryAttribute = _
    CType(attributes(GetType(CategoryAttribute)), CategoryAttribute)
    Console.WriteLine(myAttribute.Category)

Comentarios

Un CategoryAttribute indica la categoría a la que se va a asociar la propiedad o evento asociado, al enumerar propiedades o eventos en un PropertyGrid control establecido Categorized en modo. Si no se ha aplicado un CategoryAttribute objeto a una propiedad o evento, el PropertyGrid lo asocia a la categoría Misc . Se puede crear una nueva categoría para cualquier nombre especificando el nombre de la categoría en el constructor de CategoryAttribute.

La Category propiedad indica el nombre de la categoría que representa el atributo. La Category propiedad también proporciona una localización transparente de los nombres de categoría.

Notas a los desarrolladores de herederos

Si usa nombres de categoría distintos de los nombres predefinidos y desea localizar los nombres de categoría, debe invalidar el GetLocalizedString(String) método .

La CategoryAttribute clase define las siguientes categorías comunes:

Categoría	Descripción
Action	Propiedades relacionadas con las acciones disponibles.
Appearance	Propiedades relacionadas con cómo aparece una entidad.
Behavior	Propiedades relacionadas con cómo actúa una entidad.
Data	Propiedades relacionadas con la administración de datos y orígenes de datos.
Default	Propiedades agrupadas en una categoría predeterminada.
Design	Propiedades que solo están disponibles en tiempo de diseño.
DragDrop	Propiedades relacionadas con las operaciones de arrastrar y colocar.
Focus	Propiedades relacionadas con el foco.
Format	Propiedades relacionadas con el formato.
Key	Propiedades relacionadas con el teclado.
Layout	Propiedades relacionadas con el diseño.
Mouse	Propiedades relacionadas con el mouse.
WindowStyle	Propiedades relacionadas con el estilo de ventana de los formularios de nivel superior.

Para obtener más información, consulte Attributes (Atributos).

Constructores

CategoryAttribute()	Inicializa una nueva instancia de la clase CategoryAttribute utilizando el nombre de categoría Default.
CategoryAttribute(String)	Inicializa una nueva instancia de la clase CategoryAttribute utilizando el nombre de categoría especificado.

Propiedades

Action	Obtiene un objeto CategoryAttribute que representa la categoría Action.
Appearance	Obtiene un objeto CategoryAttribute que representa la categoría Appearance.
Asynchronous	Obtiene un objeto CategoryAttribute que representa la categoría Asynchronous.
Behavior	Obtiene un objeto CategoryAttribute que representa la categoría Behavior.
Category	Obtiene el nombre de la categoría correspondiente a la propiedad o al evento a los que se aplica este atributo.
Data	Obtiene un objeto CategoryAttribute que representa la categoría Data.
Default	Obtiene un objeto CategoryAttribute que representa la categoría Default.
Design	Obtiene un objeto CategoryAttribute que representa la categoría Design.
DragDrop	Obtiene un objeto CategoryAttribute que representa la categoría DragDrop.
Focus	Obtiene un objeto CategoryAttribute que representa la categoría Focus.
Format	Obtiene un objeto CategoryAttribute que representa la categoría Format.
Key	Obtiene un objeto CategoryAttribute que representa la categoría Key.
Layout	Obtiene un objeto CategoryAttribute que representa la categoría Layout.
Mouse	Obtiene un objeto CategoryAttribute que representa la categoría Mouse.
TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute)
WindowStyle	Obtiene un objeto CategoryAttribute que representa la categoría WindowStyle.

Métodos

Equals(Object)	Devuelve un valor que indica si el valor del objeto especificado es igual al atributo CategoryAttribute actual.
GetHashCode()	Devuelve el código hash de este atributo.
GetLocalizedString(String)	Busca el nombre traducido de la categoría especificada.
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsDefaultAttribute()	Determina si este atributo es el valor predeterminado.
Match(Object)	Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Consulte también

• Attribute
• PropertyDescriptor
• EventDescriptor