BrowsableAttribute Classe

Definizione

Spazio dei nomi:

System.ComponentModel

Assembly:

System.ComponentModel.Primitives.dll

Origine:

BrowsableAttribute.cs

Indica se visualizzare una proprietà o un evento in una finestra Proprietà.

public ref class BrowsableAttribute sealed : Attribute

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

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

Public NotInheritable Class BrowsableAttribute
Inherits Attribute

Ereditarietà

Object

Attribute

BrowsableAttribute

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio seguente viene contrassegnata una proprietà come esplorabile.

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

Nell'esempio successivo viene illustrato come controllare il valore dell'oggetto BrowsableAttribute per MyProperty. Prima di tutto, il codice ottiene un PropertyDescriptorCollection con tutte le proprietà per l'oggetto. Successivamente, gli indici di codice nell'oggetto PropertyDescriptorCollection per ottenere MyProperty. Restituisce quindi gli attributi per questa proprietà e li salva nella variabile attributi.

L'esempio presenta due modi diversi per controllare il valore di BrowsableAttribute. Nel secondo frammento di codice, nell'esempio viene chiamato il Equals metodo . Nell'ultimo frammento di codice, nell'esempio viene usata la Browsable proprietà per controllare il valore.

// 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

Se è stata contrassegnata una classe con BrowsableAttribute, usare il codice seguente per controllare il valore.

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

Commenti

Una finestra di progettazione visiva visualizza in genere nella Finestra Proprietà i membri che non hanno alcun attributo esplorabile o sono contrassegnati con il BrowsableAttribute parametro del browsable costruttore impostato su true. Questi membri possono essere modificati in fase di progettazione. I membri contrassegnati con il parametro del browsable costruttore impostato su false non sono appropriati per la BrowsableAttribute modifica in fase di progettazione e pertanto non vengono visualizzati in una finestra di progettazione visiva. Il valore predefinito è true.

Nota

Quando si contrassegna una proprietà con Browsable(true), il valore di questo attributo è impostato sul membro Yescostante . Per una proprietà contrassegnata con Browsable(false), il valore è No. Pertanto, quando si controlla il valore di questo attributo nel codice, è necessario specificare l'attributo come BrowsableAttribute.Yes o BrowsableAttribute.No.

Per altre informazioni, vedere Attributi.

Costruttori

BrowsableAttribute(Boolean)

Inizializza una nuova istanza della classe BrowsableAttribute.

Campi

Default	Consente di specificare il valore predefinito per l'attributo BrowsableAttribute, che è Yes. Questo campo static è di sola lettura.
No	Specifica che una proprietà o un evento non può essere modificato in fase di progettazione. Questo campo static è di sola lettura.
Yes	Specifica che una proprietà o un evento può essere modificato in fase di progettazione. Questo campo static è di sola lettura.

Proprietà

Browsable	Ottiene un valore che indica se un oggetto è esplorabile.
TypeId	Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute. (Ereditato da Attribute)

Metodi

Equals(Object)	Indica se questa istanza e un oggetto specificato sono uguali.
GetHashCode()	Restituisce il codice hash per l'istanza.
GetType()	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
IsDefaultAttribute()	Determina se questo attributo è predefinito.
Match(Object)	Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato. (Ereditato da Attribute)
MemberwiseClone()	Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)

Vedi anche

• Attribute
• PropertyDescriptor
• EventDescriptor
• AttributeCollection
• PropertyDescriptorCollection