BrowsableAttribute Klasa

Definicja

Przestrzeń nazw:

System.ComponentModel

Zestaw:

System.ComponentModel.Primitives.dll

Źródło:

BrowsableAttribute.cs

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

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

Public NotInheritable Class BrowsableAttribute
Inherits Attribute

Dziedziczenie

Object

Attribute

BrowsableAttribute

Atrybuty

AttributeUsageAttribute

Przykłady

W poniższym przykładzie właściwość jest oznaczana jako przeglądalna.

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ść dla BrowsableAttributeMyPropertyelementu . Najpierw kod pobiera PropertyDescriptorCollection obiekt ze wszystkimi właściwościami obiektu. Następnie kod indeksuje element , PropertyDescriptorCollection aby pobrać element MyProperty. 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 fragmentze kodu przykład używa Browsable właściwości , aby sprawdzić wartość.

// 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 oznaczono klasę za BrowsableAttributepomocą klasy , użyj następującego kodu, 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 przeglądania lub są oznaczone parametrem BrowsableAttribute konstruktora browsable ustawionym na truewartość . Te elementy członkowskie można modyfikować w czasie projektowania. Elementy członkowskie oznaczone parametrem BrowsableAttribute konstruktora browsable ustawione na false wartość nie są odpowiednie do edycji w czasie projektowania i dlatego nie są wyświetlane w projektancie wizualizacji. Wartość domyślna to true.

Uwaga

Po oznaczeniu właściwości Browsable(true)za pomocą parametru wartość tego atrybutu jest ustawiana na stały element członkowski Yes. W przypadku właściwości oznaczonej za pomocą Browsable(false)parametru wartość to No. Dlatego 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ą BrowsableAttributeelementu , 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 modyfikować 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.
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)

Zobacz też

• Attribute
• PropertyDescriptor
• EventDescriptor
• AttributeCollection
• PropertyDescriptorCollection