BrowsableAttribute Klasse

Definition

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
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
Vererbung
BrowsableAttribute
Attribute

Beispiele

Im folgenden Beispiel wird eine Eigenschaft als Browsable 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

Im nächsten Beispiel wird gezeigt, wie Sie den Wert des BrowsableAttribute For-Werts MyPropertyüberprüfen. Zunächst ruft der Code alle PropertyDescriptorCollection Eigenschaften für das Objekt ab. Als Nächstes wird der Code in den PropertyDescriptorCollection abrufenden MyPropertyCode indiziert. Anschließend gibt sie die Attribute für diese Eigenschaft zurück und speichert sie in der Attributevariable.

Im Beispiel werden zwei verschiedene Möglichkeiten zum Überprüfen des Werts des Werts dargestellt BrowsableAttribute. Im zweiten Codefragment ruft das Beispiel die Equals Methode auf. Im letzten Codefragment verwendet das Beispiel die Browsable Eigenschaft, 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 dem Wert 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 wird in der Regel in der Eigenschaftenfenster dieser Elemente angezeigt, die entweder kein beschriftbares Attribut haben oder mit dem Parametersatz des BrowsableAttribute Konstruktors browsable auf true" gekennzeichnet sind. Diese Mitglieder können zur Entwurfszeit geändert werden. Elemente, die mit dem Parametersatz false des Konstruktors browsable gekennzeichnet sind, sind nicht für die BrowsableAttribute Entwurfszeitbearbeitung geeignet und werden daher nicht in einem visuellen Designer angezeigt. Der Standardwert ist 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)gekennzeichnet 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.No.

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.

IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.

(Geerbt von Attribute)
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)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.

(Geerbt von Attribute)

Gilt für:

Siehe auch