BrowsableAttribute Klasa

Definicja

Określa, czy właściwość lub zdarzenie ma być wyświetlane w okno Właściwości.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
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 umożliwia przeglądania.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

W następnym przykładzie pokazano, jak sprawdzić wartość BrowsableAttribute w MyProperty.The next example shows how to check the value of the BrowsableAttribute for MyProperty. Najpierw kod pobiera PropertyDescriptorCollection ze wszystkimi właściwościami obiektu.First, the code gets a PropertyDescriptorCollection with all the properties for the object. Następnie można uzyskać MyPropertyindeksów kodu do PropertyDescriptorCollection.Next, the code indexes into the PropertyDescriptorCollection to get MyProperty. Następnie zwraca atrybuty dla tej właściwości i zapisuje je w zmiennej atrybutów.Then it returns the attributes for this property and saves them in the attributes variable.

W przykładzie przedstawiono dwa różne sposoby sprawdzania wartości BrowsableAttribute.The example presents two different ways of checking the value of the BrowsableAttribute. W drugim fragmencie kodu, przykład wywołuje metodę Equals.In the second code fragment, the example calls the Equals method. W ostatnim fragmencie kodu przykład używa właściwości Browsable do sprawdzenia wartości.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 

Jeśli klasa została oznaczona przy użyciu BrowsableAttribute, użyj następującego kodu, aby sprawdzić wartość.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 

Uwagi

Projektant wizualny jest zwykle wyświetlany w okno Właściwości tych elementów członkowskich, które nie mają atrybutu umożliwia przeglądania lub są oznaczone za pomocą parametru browsable konstruktora BrowsableAttribute ustawionego na true.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. Te elementy członkowskie można modyfikować w czasie projektowania.These members can be modified at design time. Elementy członkowskie oznaczone parametrem browsable konstruktora BrowsableAttribute ustawione na false nie są odpowiednie do edycji w czasie projektowania i dlatego nie są wyświetlane w projektancie wizualizacji.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. Wartość domyślna to true.The default is true.

Uwaga

Po oznaczeniu właściwości Browsable(true), wartość tego atrybutu jest ustawiana na stałą Yeselementu członkowskiego.When you mark a property with Browsable(true), the value of this attribute is set to the constant member Yes. Dla właściwości oznaczonej Browsable(false), wartość jest No.For a property marked with Browsable(false), the value is No. W związku z tym, gdy sprawdzasz wartość tego atrybutu w kodzie, musisz określić atrybut jako BrowsableAttribute.Yes lub BrowsableAttribute.No.Therefore, when you check the value of this attribute in your code, you must specify the attribute as BrowsableAttribute.Yes or BrowsableAttribute.No.

Aby uzyskać więcej informacji, zobacz atrybuty.For more information, see Attributes.

Konstruktory

BrowsableAttribute(Boolean)

Inicjuje nowe wystąpienie klasy BrowsableAttribute klasy.Initializes a new instance of the BrowsableAttribute class.

Pola

Default

Określa wartość domyślną BrowsableAttribute, która jest Yes.Specifies the default value for the BrowsableAttribute, which is Yes. To static pole jest tylko do odczytu.This static field is read-only.

No

Określa, że nie można zmodyfikować właściwości lub zdarzenia w czasie projektowania.Specifies that a property or event cannot be modified at design time. To static pole jest tylko do odczytu.This static field is read-only.

Yes

Określa, że właściwość lub zdarzenie może być modyfikowane w czasie projektowania.Specifies that a property or event can be modified at design time. To static pole jest tylko do odczytu.This static field is read-only.

Właściwości

Browsable

Pobiera wartość wskazującą, czy obiekt jest umożliwia przeglądania.Gets a value indicating whether an object is browsable.

TypeId

Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Odziedziczone po Attribute)

Metody

Equals(Object)

Wskazuje, czy to wystąpienie oraz określony obiekt są równe.Indicates whether this instance and a specified object are equal.

GetHashCode()

Zwraca kod skrótu dla tego wystąpienia.Returns the hash code for this instance.

GetType()

Pobiera Type bieżącego wystąpienia.Gets the Type of the current instance.

(Odziedziczone po Object)
IsDefaultAttribute()

Określa, czy ten atrybut jest wartością domyślną.Determines if this attribute is the default.

Match(Object)

Gdy jest zastępowany w klasie pochodnej, zwraca wartość wskazującą, czy to wystąpienie jest zgodne z określonym obiektem.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Odziedziczone po Attribute)
MemberwiseClone()

Tworzy skróconą kopię bieżącego Object.Creates a shallow copy of the current Object.

(Odziedziczone po Object)
ToString()

Zwraca ciąg, który reprezentuje bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)

Jawne implementacje interfejsu

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

Zestaw nazw jest mapowany na odpowiedni zestaw identyfikatorów wysyłania.Maps a set of names to a corresponding set of dispatch identifiers.

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

Pobiera informacje o typie dla obiektu, którego można użyć do uzyskania informacji o typie dla interfejsu.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Odziedziczone po Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Pobiera informację o liczbie typów interfejsów, jakie zawiera obiekt (0 lub 1).Retrieves the number of type information interfaces that an object provides (either 0 or 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.Provides access to properties and methods exposed by an object.

(Odziedziczone po Attribute)

Dotyczy

Zobacz też