BrowsableAttribute BrowsableAttribute BrowsableAttribute BrowsableAttribute Class

Définition

Spécifie si une propriété ou un événement doivent être affichés dans une fenêtre Propriétés.Specifies whether a property or event should be displayed in a Properties window.

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

Exemples

L’exemple suivant marque une propriété comme pouvant être explorée.The following example marks a property as browsable.

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. MyPropertyThe next example shows how to check the value of the BrowsableAttribute for MyProperty. Tout d’abord, le code PropertyDescriptorCollection obtient un avec toutes les propriétés de l’objet.First, the code gets a PropertyDescriptorCollection with all the properties for the object. Ensuite, le code est indexé dans le PropertyDescriptorCollection à récupérer MyProperty.Next, the code indexes into the PropertyDescriptorCollection to get MyProperty. Elle retourne ensuite les attributs de cette propriété et les enregistre dans la variable d’attributs.Then it returns the attributes for this property and saves them in the attributes variable.

L’exemple présente deux méthodes différentes de vérification de la valeur de BrowsableAttribute.The example presents two different ways of checking the value of the BrowsableAttribute. Dans le deuxième fragment de code, l’exemple appelle Equals la méthode.In the second code fragment, the example calls the Equals method. Dans le dernier fragment de code, l’exemple utilise Browsable la propriété pour vérifier la valeur.In the last code fragment, the example uses the Browsable property to check the value.

// 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.If you marked a class with the BrowsableAttribute, use the following code to check the value.

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 BrowsableAttribute le paramètre browsable du constructeur défini truesur.A visual designer typically displays in the Properties window those members that either have no browsable attribute or are marked with the BrowsableAttribute constructor's browsable parameter set to true. Ces membres peuvent être modifiés au moment de la conception.These members can be modified at design time. Les membres marqués avec BrowsableAttribute le paramètre browsable du constructeur ayant false la valeur ne sont pas appropriés pour la modification au moment du design et ne sont donc pas affichés dans un concepteur visuel.Members marked with the BrowsableAttribute constructor's browsable parameter set to false are not appropriate for design-time editing and therefore are not displayed in a visual designer. La valeur par défaut est true.The default is true.

Notes

Lorsque vous marquez une propriété Browsable(true)avec, la valeur de cet attribut est définie sur le membre Yesconstant.When you mark a property with Browsable(true), the value of this attribute is set to the constant member Yes. Pour une propriété marquée avec Browsable(false), la valeur est No.For a property marked with Browsable(false), the value is No. Par conséquent, lorsque vous vérifiez la valeur de cet attribut dans votre code, vous devez spécifier l’attribut BrowsableAttribute.Yes en BrowsableAttribute.Notant que ou.Therefore, when you check the value of this attribute in your code, you must specify the attribute as BrowsableAttribute.Yes or BrowsableAttribute.No.

Pour plus d’informations, consultez Attributs.For more information, see Attributes.

Constructeurs

BrowsableAttribute(Boolean) BrowsableAttribute(Boolean) BrowsableAttribute(Boolean) BrowsableAttribute(Boolean)

Initialise une nouvelle instance de la classe BrowsableAttribute.Initializes a new instance of the BrowsableAttribute class.

Champs

Default Default Default Default

Spécifie la valeur par défaut de BrowsableAttribute (Yes).Specifies the default value for the BrowsableAttribute, which is Yes. Ce champ static est en lecture seule.This static field is read-only.

No No No No

Spécifie qu'une propriété ou un événement ne peut pas être modifié au moment du design.Specifies that a property or event cannot be modified at design time. Ce champ static est en lecture seule.This static field is read-only.

Yes Yes Yes Yes

Spécifie qu'une propriété ou un événement peut être modifié au moment du design.Specifies that a property or event can be modified at design time. Ce champ static est en lecture seule.This static field is read-only.

Propriétés

Browsable Browsable Browsable Browsable

Obtient une valeur indiquant si un objet est consultable.Gets a value indicating whether an object is browsable.

TypeId TypeId TypeId TypeId

Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Méthodes

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Indique si cette instance et un objet spécifié sont égaux.Indicates whether this instance and a specified object are equal.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Retourne le code de hachage de cette instance.Returns the hash code for this instance.

GetType() GetType() GetType() GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Détermine si cet attribut est l'attribut par défaut.Determines if this attribute is the default.

Match(Object) Match(Object) Match(Object) Match(Object)

En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Inherited from Object)

Implémentations d’interfaces explicites

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

Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _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.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) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 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) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _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.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

S’applique à

Voir aussi