CategoryAttribute Class

Definición

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. Specifies the name of the category in which to group the property or event when displayed in a PropertyGrid control set to Categorized mode.

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

Ejemplos

En el ejemplo siguiente se crea el MyImage propiedad.The following example creates the MyImage property. La propiedad tiene dos atributos: un DescriptionAttribute y un CategoryAttribute.The property has two attributes: a DescriptionAttribute and a 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 para MyImage.The next example gets the category for MyImage. En primer lugar, el código obtiene una PropertyDescriptorCollection con todas las propiedades del objeto.First, the code gets a PropertyDescriptorCollection with all the properties for the object. A continuación, el código se indiza en la PropertyDescriptorCollection obtener MyImage.Next, the code indexes into the PropertyDescriptorCollection to get MyImage. A continuación, devuelve los atributos de esta propiedad y los guarda en la variable attributes.Then it returns the attributes for this property and saves them in the variable attributes.

A continuación, en el ejemplo imprime la categoría recuperando CategoryAttribute desde el AttributeCollectiony escribirlo en la pantalla de la consola.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 = 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 para asociar la propiedad asociada o el evento, al enumerar las propiedades o eventos en un PropertyGrid establecer control Categorized modo.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. Si un CategoryAttribute no se ha aplicado a una propiedad o evento, el PropertyGrid lo asocia a la Misc categoría.If a CategoryAttribute has not been applied to a property or event, the PropertyGrid associates it with the Misc category. Puede crearse una nueva categoría para cualquier nombre especificando el nombre de la categoría en el constructor para la CategoryAttribute.A new category can be created for any name by specifying the name of the category in the constructor for the CategoryAttribute.

El Category propiedad indica el nombre de la categoría que representa el atributo.The Category property indicates the name of the category that the attribute represents. El Category propiedad también proporciona una localización transparente de los nombres de categoría.The Category property also provides transparent localization of category names.

Notas a los desarrolladores de herederos

Si usa nombres de categoría diferentes los nombres predefinidos y desea localizar los nombres de categoría, se debe reemplazar el GetLocalizedString(String) método. El CategoryAttribute clase define las siguientes categorías comunes:

categoría descripción
Action Propiedades relacionadas con las acciones disponibles.
Appearance Propiedades relacionadas con la apariencia de una entidad.
Behavior Propiedades relacionadas con la forma en que actúa una entidad.
Data Propiedades relacionadas con datos y administración del origen de datos.
Default Propiedades que se agrupan en una categoría predeterminada.
Design Propiedades que están disponibles sólo en tiempo de diseño.
DragDrop Propiedades relacionadas con 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 formularios de nivel superior.
Para obtener más información, consulte atributos.

If you use category names other than the predefined names, and you want to localize your category names, you must override the GetLocalizedString(String) method. 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.

Constructores

CategoryAttribute()

Inicializa una nueva instancia de la clase CategoryAttribute utilizando el nombre de categoría Default. Initializes a new instance of the CategoryAttribute class using the category name Default.

CategoryAttribute(String)

Inicializa una nueva instancia de la clase CategoryAttribute utilizando el nombre de categoría especificado. Initializes a new instance of the CategoryAttribute class using the specified category name.

Propiedades

Action

Obtiene un objeto CategoryAttribute que representa la categoría Action. Gets a CategoryAttribute representing the Action category.

Appearance

Obtiene un objeto CategoryAttribute que representa la categoría Appearance. Gets a CategoryAttribute representing the Appearance category.

Asynchronous

Obtiene un objeto CategoryAttribute que representa la categoría Asynchronous. Gets a CategoryAttribute representing the Asynchronous category.

Behavior

Obtiene un objeto CategoryAttribute que representa la categoría Behavior. Gets a CategoryAttribute representing the Behavior category.

Category

Obtiene el nombre de la categoría correspondiente a la propiedad o al evento a los que se aplica este atributo. Gets the name of the category for the property or event that this attribute is applied to.

Data

Obtiene un objeto CategoryAttribute que representa la categoría Data. Gets a CategoryAttribute representing the Data category.

Default

Obtiene un objeto CategoryAttribute que representa la categoría Default. Gets a CategoryAttribute representing the Default category.

Design

Obtiene un objeto CategoryAttribute que representa la categoría Design. Gets a CategoryAttribute representing the Design category.

DragDrop

Obtiene un objeto CategoryAttribute que representa la categoría DragDrop. Gets a CategoryAttribute representing the DragDrop category.

Focus

Obtiene un objeto CategoryAttribute que representa la categoría Focus. Gets a CategoryAttribute representing the Focus category.

Format

Obtiene un objeto CategoryAttribute que representa la categoría Format. Gets a CategoryAttribute representing the Format category.

Key

Obtiene un objeto CategoryAttribute que representa la categoría Key. Gets a CategoryAttribute representing the Key category.

Layout

Obtiene un objeto CategoryAttribute que representa la categoría Layout. Gets a CategoryAttribute representing the Layout category.

Mouse

Obtiene un objeto CategoryAttribute que representa la categoría Mouse. Gets a CategoryAttribute representing the Mouse category.

TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)
WindowStyle

Obtiene un objeto CategoryAttribute que representa la categoría WindowStyle. Gets a CategoryAttribute representing the WindowStyle category.

Métodos

Equals(Object)

Indica si el valor del objeto especificado es igual al CategoryAttribute actual. Returns whether the value of the given object is equal to the current CategoryAttribute..

GetHashCode()

Devuelve el código hash de este atributo. Returns the hash code for this attribute.

GetLocalizedString(String)

Busca el nombre traducido de la categoría especificada. Looks up the localized name of the specified category.

GetType()

Obtiene el Type de la instancia actual. Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

Determina si este atributo es el valor predeterminado. Determines if this attribute is the default.

Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Crea una copia superficial del Object actual. Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Devuelve una cadena que representa el objeto actual. Returns a string that represents the current object.

(Inherited from Object)

Implementaciones de interfaz explícitas

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío. Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz. Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1). Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto. Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Se aplica a

Consultar también