BrowsableAttribute Class

Definition

Gibt an, ob eine Eigenschaft oder ein Ereignis im Eigenschaftenfenster angezeigt werden sollte.Specifies whether a property or event should be displayed in a Properties window.

public ref class BrowsableAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public sealed class BrowsableAttribute : Attribute
public sealed class BrowsableAttribute : Attribute
type BrowsableAttribute = class
    inherit Attribute
Public NotInheritable Class BrowsableAttribute
Inherits Attribute
Inheritance
BrowsableAttribute
Attributes

Examples

Im folgenden Beispiel wird eine Eigenschaft als durchsuchbar markiert.The following example marks a property as browsable.

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 der BrowsableAttribute für MyPropertyüberprüfen.The next example shows how to check the value of the BrowsableAttribute for MyProperty. Zuerst erhält der Code eine PropertyDescriptorCollection mit allen Eigenschaften für das-Objekt.First, the code gets a PropertyDescriptorCollection with all the properties for the object. Als nächstes indiziert der Code die PropertyDescriptorCollection, um MyPropertyzu erhalten.Next, the code indexes into the PropertyDescriptorCollection to get MyProperty. Anschließend werden die Attribute für diese Eigenschaft zurückgegeben und in der Attribut Variablen gespeichert.Then it returns the attributes for this property and saves them in the attributes variable.

Das Beispiel zeigt zwei verschiedene Möglichkeiten, den Wert der BrowsableAttributezu überprüfen.The example presents two different ways of checking the value of the BrowsableAttribute. Im zweiten Code Fragment Ruft das Beispiel die Equals-Methode auf.In the second code fragment, the example calls the Equals method. Im letzten Code Fragment verwendet das Beispiel die Browsable-Eigenschaft, um den Wert zu überprüfen.In the last code fragment, the example uses the Browsable property to check the value.

// 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 der BrowsableAttributegekennzeichnet haben, verwenden Sie den folgenden Code, um den Wert zu überprüfen.If you marked a class with the BrowsableAttribute, use the following code to check the value.

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 

Remarks

Ein visueller Designer wird in der Regel im Eigenschaftenfenster Elemente angezeigt, die entweder kein durch suchbares Attribut haben oder mit dem browsable-Parameter des BrowsableAttribute-Konstruktors gekennzeichnet sind, der auf truefestgelegt ist.A visual designer typically displays in the Properties window those members that either have no browsable attribute or are marked with the BrowsableAttribute constructor's browsable parameter set to true. Diese Member können zur Entwurfszeit geändert werden.These members can be modified at design time. Member, die mit dem auf false festgelegten browsable Parameter des BrowsableAttribute-Konstruktors gekennzeichnet sind, sind nicht für die Bearbeitung der Entwurfszeit geeignet und werden daher nicht in einem visuellen Designer angezeigt.Members marked with the BrowsableAttribute constructor's browsable parameter set to false are not appropriate for design-time editing and therefore are not displayed in a visual designer. Der Standardwert lautet true.The default is true.

Note

Wenn Sie eine Eigenschaft mit Browsable(true)markieren, wird der Wert dieses Attributs auf das Konstante Element Yesfestgelegt.When you mark a property with Browsable(true), the value of this attribute is set to the constant member Yes. Für eine Eigenschaft, die mit Browsable(false)gekennzeichnet ist, wird der Wert No.For a property marked with Browsable(false), the value is No. Wenn Sie daher den Wert dieses Attributs im Code überprüfen, müssen Sie das-Attribut als BrowsableAttribute.Yes oder BrowsableAttribute.Noangeben.Therefore, when you check the value of this attribute in your code, you must specify the attribute as BrowsableAttribute.Yes or BrowsableAttribute.No.

Weitere Informationen finden Sie unter Attribute.For more information, see Attributes.

Constructors

BrowsableAttribute(Boolean)

Initialisiert eine neue Instanz der Klasse BrowsableAttribute.Initializes a new instance of the BrowsableAttribute class.

Fields

Default

Gibt den Standardwert für das BrowsableAttribute an, der Yes ist.Specifies the default value for the BrowsableAttribute, which is Yes. Dieses static-Feld ist schreibgeschützt.This static field is read-only.

No

Gibt an, dass eine Eigenschaft oder ein Ereignis zur Entwurfszeit nicht geändert werden kann.Specifies that a property or event cannot be modified at design time. Dieses static-Feld ist schreibgeschützt.This static field is read-only.

Yes

Gibt an, dass eine Eigenschaft oder ein Ereignis zur Entwurfszeit geändert werden kann.Specifies that a property or event can be modified at design time. Dieses static-Feld ist schreibgeschützt.This static field is read-only.

Properties

Browsable

Ruft einen Wert ab, der angibt, ob ein Objekt browsebar ist.Gets a value indicating whether an object is browsable.

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object)

Gibt an, ob diese Instanz und ein angegebenes Objekt gleich sind.Indicates whether this instance and a specified object are equal.

GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

Bestimmt, ob dieses Attribut der Standardwert ist.Determines if this attribute is the default.

IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from 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.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from 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.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to

See also