BrowsableAttribute Classe

Définition

Spécifie si une propriété ou un événement doivent être affichés dans une fenêtre Propriétés.

public ref class BrowsableAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public sealed class BrowsableAttribute : Attribute
public sealed class BrowsableAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.All)>]
type BrowsableAttribute = class
    inherit Attribute
type BrowsableAttribute = class
    inherit Attribute
Public NotInheritable Class BrowsableAttribute
Inherits Attribute
Héritage
BrowsableAttribute
Attributs

Exemples

L’exemple suivant marque une propriété comme pouvant être explorée.

public:
   [Browsable(true)]
   property int MyProperty 
   {
      int get()
      {
         // Insert code here.
         return 0;
      }
      void set( int value )
      {
         // Insert code here.
      }
   }
[Browsable(true)]
public int MyProperty
{
    get
    {
        // Insert code here.
        return 0;
    }
    set
    {
        // Insert code here.
    }
}

<Browsable(True)> _
Public Property MyProperty() As Integer
    Get
        ' Insert code here.
        Return 0
    End Get
    Set
        ' Insert code here.
    End Set 
End Property

L’exemple suivant montre comment vérifier la valeur de BrowsableAttribute pour MyProperty . Tout d’abord, le code obtient un PropertyDescriptorCollection avec toutes les propriétés de l’objet. Ensuite, le code est indexé dans le PropertyDescriptorCollection à récupérer MyProperty . Elle retourne ensuite les attributs de cette propriété et les enregistre dans la variable d’attributs.

L’exemple présente deux méthodes différentes de vérification de la valeur de BrowsableAttribute . Dans le deuxième fragment de code, l’exemple appelle la Equals méthode. Dans le dernier fragment de code, l’exemple utilise la Browsable propriété pour vérifier la valeur.

// Gets the attributes for the property.
AttributeCollection^ attributes = TypeDescriptor::GetProperties( this )[ "MyProperty" ]->Attributes;

// Checks to see if the value of the BrowsableAttribute is Yes.
if ( attributes[ BrowsableAttribute::typeid ]->Equals( BrowsableAttribute::Yes ) )
{
   
   // Insert code here.
}

// This is another way to see whether the property is browsable.
BrowsableAttribute^ myAttribute = dynamic_cast<BrowsableAttribute^>(attributes[ BrowsableAttribute::typeid ]);
if ( myAttribute->Browsable )
{
   // Insert code here.
}
// Gets the attributes for the property.
AttributeCollection attributes =
   TypeDescriptor.GetProperties(this)["MyProperty"].Attributes;

// Checks to see if the value of the BrowsableAttribute is Yes.
if (attributes[typeof(BrowsableAttribute)].Equals(BrowsableAttribute.Yes))
{
    // Insert code here.
}

// This is another way to see whether the property is browsable.
BrowsableAttribute myAttribute =
   (BrowsableAttribute)attributes[typeof(BrowsableAttribute)];
if (myAttribute.Browsable)
{
    // Insert code here.
}
' Gets the attributes for the property.
Dim attributes As AttributeCollection = _
    TypeDescriptor.GetProperties(Me)("MyProperty").Attributes

' Checks to see if the value of the BrowsableAttribute is Yes.
If attributes(GetType(BrowsableAttribute)).Equals(BrowsableAttribute.Yes) Then
    ' Insert code here.
End If 

' This is another way to see whether the property is browsable.
Dim myAttribute As BrowsableAttribute = _
    CType(attributes(GetType(BrowsableAttribute)), BrowsableAttribute)
If myAttribute.Browsable Then
    ' Insert code here.
End If

Si vous avez marqué une classe avec BrowsableAttribute , utilisez le code suivant pour vérifier la valeur.

AttributeCollection^ attributes = TypeDescriptor::GetAttributes( MyProperty );
if ( attributes[ BrowsableAttribute::typeid ]->Equals( BrowsableAttribute::Yes ) )
{
   // Insert code here.
}
AttributeCollection attributes =
    TypeDescriptor.GetAttributes(MyProperty);
if (attributes[typeof(BrowsableAttribute)].Equals(BrowsableAttribute.Yes))
{
    // Insert code here.
}
Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(MyProperty)
If attributes(GetType(BrowsableAttribute)).Equals(BrowsableAttribute.Yes) Then
    ' Insert code here.
End If

Remarques

Un concepteur visuel affiche généralement dans le Fenêtre Propriétés les membres qui n’ont pas d’attribut Browsable ou qui sont marqués avec le BrowsableAttribute paramètre du constructeur browsable défini sur true . Ces membres peuvent être modifiés au moment de la conception. Les membres marqués avec le BrowsableAttribute paramètre du constructeur browsable ayant la valeur ne false sont pas appropriés pour la modification au moment du design et ne sont donc pas affichés dans un concepteur visuel. La valeur par défaut est true.

Notes

Lorsque vous marquez une propriété avec Browsable(true) , la valeur de cet attribut est définie sur le membre constant Yes . Pour une propriété marquée avec Browsable(false) , la valeur est No . Par conséquent, lorsque vous vérifiez la valeur de cet attribut dans votre code, vous devez spécifier l’attribut en tant que BrowsableAttribute.Yes ou BrowsableAttribute.No .

Pour plus d’informations, consultez Attributs.

Constructeurs

BrowsableAttribute(Boolean)

Initialise une nouvelle instance de la classe BrowsableAttribute.

Champs

Default

Spécifie la valeur par défaut de BrowsableAttribute (Yes). Ce champ static est en lecture seule.

No

Spécifie qu'une propriété ou un événement ne peut pas être modifié au moment du design. Ce champ static est en lecture seule.

Yes

Spécifie qu'une propriété ou un événement peut être modifié au moment du design. Ce champ static est en lecture seule.

Propriétés

Browsable

Obtient une valeur indiquant si un objet est consultable.

TypeId

Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute.

(Hérité de Attribute)

Méthodes

Equals(Object)

Indique si cette instance et un objet spécifié sont égaux.

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.

IsDefaultAttribute()

En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée.

(Hérité de Attribute)
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)

Implémentations d’interfaces explicites

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

Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch.

(Hérité de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface.

(Hérité de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1).

(Hérité de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fournit l'accès aux propriétés et aux méthodes exposées par un objet.

(Hérité de Attribute)

S’applique à

Voir aussi