BrowsableAttribute Klasse

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.Primitives.dll

Quelle:

BrowsableAttribute.cs

Gibt an, ob eine Eigenschaft oder ein Ereignis im Eigenschaftenfenster angezeigt werden sollte.

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

Vererbung

Object

Attribute

BrowsableAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Beispiel wird eine Eigenschaft als durchbrowsbar markiert.

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

Das nächste Beispiel zeigt, wie der Wert von BrowsableAttribute für MyPropertyüberprüft wird. Zunächst ruft der Code eine PropertyDescriptorCollection mit allen Eigenschaften für das -Objekt ab. Als Nächstes wird der Code in den PropertyDescriptorCollection indiziert, um abzurufen MyProperty. Anschließend werden die Attribute für diese Eigenschaft zurückgegeben und in der Variablen attribute gespeichert.

Das Beispiel zeigt zwei verschiedene Möglichkeiten zum Überprüfen des Werts von BrowsableAttribute. Im zweiten Codefragment ruft das Beispiel die -Methode auf Equals . Im letzten Codefragment wird im Beispiel die Browsable -Eigenschaft verwendet, um den Wert zu überprüfen.

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

Wenn Sie eine Klasse mit BrowsableAttributemarkiert haben, verwenden Sie den folgenden Code, um den Wert zu überprüfen.

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

Hinweise

Ein visueller Designer zeigt in der Regel im Eigenschaftenfenster die Member an, die entweder über kein durchbrochenes Attribut verfügen oder die mit dem parameter des browsable Konstruktors gekennzeichnet sind, der BrowsableAttribute auf truefestgelegt ist. Diese Elemente können zur Entwurfszeit geändert werden. Member, die mit dem BrowsableAttribute Parameter des browsable Konstruktors auf gekennzeichnet false sind, sind nicht für die Entwurfszeitbearbeitung geeignet und werden daher nicht in einem visuellen Designer angezeigt. Der Standardwert lautet true.

Hinweis

Wenn Sie eine Eigenschaft mit Browsable(true)markieren, wird der Wert dieses Attributs auf das konstante Element Yesfestgelegt. Für eine Eigenschaft, die mit Browsable(false)markiert ist, ist Noder Wert . Wenn Sie daher den Wert dieses Attributs in Ihrem Code überprüfen, müssen Sie das Attribut als BrowsableAttribute.Yes oder BrowsableAttribute.Noangeben.

Weitere Informationen finden Sie unter Attribute.

Konstruktoren

BrowsableAttribute(Boolean)

Initialisiert eine neue Instanz der BrowsableAttribute-Klasse.

Felder

Default	Gibt den Standardwert für das BrowsableAttribute an, der Yes ist. Dieses static-Feld ist schreibgeschützt.
No	Gibt an, dass eine Eigenschaft oder ein Ereignis zur Entwurfszeit nicht geändert werden kann. Dieses static-Feld ist schreibgeschützt.
Yes	Gibt an, dass eine Eigenschaft oder ein Ereignis zur Entwurfszeit geändert werden kann. Dieses static-Feld ist schreibgeschützt.

Eigenschaften

Browsable	Ruft einen Wert ab, der angibt, ob ein Objekt browsebar ist.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Gibt an, ob diese Instanz und ein angegebenes Objekt gleich sind.
GetHashCode()	Gibt den Hashcode für diese Instanz zurück.
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Bestimmt, ob dieses Attribut der Standardwert ist.
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• Attribute
• PropertyDescriptor
• EventDescriptor
• AttributeCollection
• PropertyDescriptorCollection