BrowsableAttribute Klasa

Definicja

Określa, czy właściwość lub zdarzenie powinny być wyświetlane w okno Właściwości.

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
Dziedziczenie
BrowsableAttribute
Atrybuty

Przykłady

Poniższy przykład oznacza właściwość jako możliwość przeglądania.

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

W następnym przykładzie pokazano, jak sprawdzić wartość BrowsableAttribute elementu dla MyPropertyelementu . Najpierw kod pobiera PropertyDescriptorCollection obiekt ze wszystkimi właściwościami obiektu. Następnie kod indeksuje do PropertyDescriptorCollection elementu , aby pobrać MyPropertyelement . Następnie zwraca atrybuty tej właściwości i zapisuje je w zmiennej atrybutów.

W przykładzie przedstawiono dwa różne sposoby sprawdzania wartości elementu BrowsableAttribute. W drugim fragmentze kodu przykład wywołuje metodę Equals . W ostatnim fragmentcie kodu w przykładzie użyto Browsable właściwości do sprawdzenia wartości.

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

Jeśli oznaczyliśmy klasę za pomocą polecenia , użyj następującego BrowsableAttributekodu, aby sprawdzić wartość.

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

Uwagi

Projektant wizualizacji zazwyczaj wyświetla w okno Właściwości tych elementów członkowskich, które nie mają atrybutu do przeglądania lub są oznaczone parametrem konstruktora browsable ustawionym BrowsableAttribute na true. Te elementy członkowskie można modyfikować w czasie projektowania. Elementy członkowskie oznaczone zestawem BrowsableAttribute false parametrów konstruktora browsable nie są odpowiednie do edycji w czasie projektowania i dlatego nie są wyświetlane w projektancie wizualizacji. Wartość domyślna to true.

Uwaga

Gdy oznaczysz właściwość z wartością Browsable(true), wartość tego atrybutu jest ustawiona na stały element członkowski Yes. Dla właściwości oznaczonej znakiem Browsable(false), wartość to No. W związku z tym podczas sprawdzania wartości tego atrybutu w kodzie należy określić atrybut jako BrowsableAttribute.Yes lub BrowsableAttribute.No.

Aby uzyskać więcej informacji, zobacz Atrybuty.

Konstruktory

BrowsableAttribute(Boolean)

Inicjuje nowe wystąpienie klasy BrowsableAttribute.

Pola

Default

Określa wartość domyślną elementu BrowsableAttribute, czyli Yes. To static pole jest tylko do odczytu.

No

Określa, że nie można zmodyfikować właściwości lub zdarzenia w czasie projektowania. To static pole jest tylko do odczytu.

Yes

Określa, że właściwość lub zdarzenie można zmodyfikować w czasie projektowania. To static pole jest tylko do odczytu.

Właściwości

Browsable

Pobiera wartość wskazującą, czy obiekt można przeglądać.

TypeId

Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego Attributeelementu .

(Odziedziczone po Attribute)

Metody

Equals(Object)

Wskazuje, czy to wystąpienie oraz określony obiekt są równe.

GetHashCode()

Zwraca wartość skrótu dla tego wystąpienia.

GetType()

Type Pobiera wartość bieżącego wystąpienia.

(Odziedziczone po Object)
IsDefaultAttribute()

Określa, czy ten atrybut jest domyślny.

IsDefaultAttribute()

W przypadku zastąpienia w klasie pochodnej wskazuje, czy wartość tego wystąpienia jest wartością domyślną klasy pochodnej.

(Odziedziczone po Attribute)
Match(Object)

Po przesłonięciu w klasie pochodnej zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi.

(Odziedziczone po Attribute)
MemberwiseClone()

Tworzy płytkią kopię bieżącego Objectelementu .

(Odziedziczone po Object)
ToString()

Zwraca ciąg reprezentujący bieżący obiekt.

(Odziedziczone po Object)

Jawne implementacje interfejsu

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

Zestaw nazw jest mapowany na odpowiedni zestaw identyfikatorów wysyłania.

(Odziedziczone po Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Pobiera informacje o typie dla obiektu, który może służyć do pobierania informacji o typie dla interfejsu.

(Odziedziczone po Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Pobiera informację o liczbie typów interfejsów, jakie zawiera obiekt (0 lub 1).

(Odziedziczone po Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Umożliwia dostęp do właściwości i metod udostępnianych przez obiekt.

(Odziedziczone po Attribute)

Dotyczy

Zobacz też