DesignerCategoryAttribute Classe

Définition

Espace de noms:

System.ComponentModel

Assembly:

System.ComponentModel.Primitives.dll

Source:

DesignerCategoryAttribute.cs

Spécifie que le concepteur pour une classe appartient à une certaine catégorie.

public ref class DesignerCategoryAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=true)]
public sealed class DesignerCategoryAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=true)>]
type DesignerCategoryAttribute = class
    inherit Attribute

Public NotInheritable Class DesignerCategoryAttribute
Inherits Attribute

Héritage

Object

Attribute

DesignerCategoryAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple suivant crée une classe appelée MyForm. MyForm a deux attributs : un DesignerAttribute qui spécifie cette classe utilise le DocumentDesigner, et un DesignerCategoryAttribute qui spécifie la Form catégorie.

[Designer("System.Windows.Forms.Design.DocumentDesigner, System.Windows.Forms.Design",
IRootDesigner::typeid),
DesignerCategory("Form")]
ref class MyForm: public ContainerControl{
   // Insert code here.
};

[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", _
    GetType(IRootDesigner)), DesignerCategory("Form")> _
Public Class MyForm
    
    Inherits ContainerControl
    ' Insert code here.
End Class

L’exemple suivant crée une instance de MyForm. Ensuite, il obtient les attributs de la classe, extrait le DesignerCategoryAttributeet imprime le nom du concepteur.

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;
}

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;
}

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

Remarques

Un concepteur visuel peut utiliser une catégorie de concepteur pour informer un environnement de développement du type de concepteur qui sera implémenté. Si aucune catégorie de concepteur n’est fournie sur une classe, un environnement de développement peut ou non autoriser la conception de la classe. Une catégorie peut être créée pour n’importe quel nom.

Lorsque vous marquez une classe avec cet attribut, elle est définie sur un membre constant. Lorsque vous souhaitez case activée la valeur de cet attribut dans votre code, vous devez spécifier le membre constant. La colonne Description du tableau ci-dessous répertorie le membre constant sur lequel chaque valeur est définie.

La DesignerCategoryAttribute classe définit les catégories courantes suivantes :

Category	Description
Composant	Concepteurs utilisés avec des composants. L’attribut est défini sur le membre DesignerCategoryAttribute.Componentconstant .
Formulaire	Concepteurs utilisés avec des formulaires. L’attribut est défini sur le membre DesignerCategoryAttribute.Formconstant .
Designer	Concepteurs utilisés avec les concepteurs. L’attribut est défini sur le membre DesignerCategoryAttribute.Genericconstant .
Chaîne vide («  »)	Il s’agit de la catégorie par défaut.

Pour plus d’informations, consultez Attributs.

Constructeurs

DesignerCategoryAttribute()	Initialise une nouvelle instance de la classe DesignerCategoryAttribute avec une chaîne vide ("").
DesignerCategoryAttribute(String)	Initialise une nouvelle instance de la classe DesignerCategoryAttribute avec le nom de catégorie donné.

Champs

Component	Spécifie qu'un composant de cette catégorie utilise un Concepteur de composants. Ce champ est en lecture seule.
Default	Spécifie qu'un composant de cette catégorie ne peut pas utiliser de Concepteur de composants. Ce champ static est en lecture seule.
Form	Spécifie qu'un composant de cette catégorie utilise un Concepteur de formulaires. Ce champ static est en lecture seule.
Generic	Spécifie qu'un composant de cette catégorie utilise un concepteur générique. Ce champ static est en lecture seule.

Propriétés

Category	Obtient le nom de la catégorie.
TypeId	Obtient un identificateur unique pour cet attribut.

Méthodes

Equals(Object)	Retourne une valeur indiquant si la valeur de l'objet donné est égale au DesignOnlyAttribute en cours.
GetHashCode()	Retourne le code de hachage de cette instance.
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IsDefaultAttribute()	Détermine si cet attribut est l'attribut par défaut.
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Voir aussi

• Attribute
• DesignerAttribute