BrowsableAttribute Osztály

Definíció

Névtér:

System.ComponentModel

Szerelvények:

netstandard.dll, System.ComponentModel.Primitives.dll

Forrás:

BrowsableAttribute.cs

Megadja, hogy egy tulajdonság vagy esemény megjelenjen-e egy Tulajdonságok ablak.

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

Öröklődés

Object

Attribute

BrowsableAttribute

Attribútumok

AttributeUsageAttribute

Példák

Az alábbi példa egy tulajdonságot kereshetőként jelöl meg.

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

A következő példa bemutatja, hogyan ellenőrizheti a következő BrowsableAttributeérték értékétMyProperty. Először is a kód lekéri PropertyDescriptorCollection az objektum összes tulajdonságát. Ezután a kód indexel a PropertyDescriptorCollection lekéréshez MyProperty. Ezután visszaadja a tulajdonság attribútumait, és menti őket az attribútumváltozóba.

A példa két különböző módszert mutat be az érték ellenőrzésére BrowsableAttribute. A második kódrészletben a példa meghívja a metódust Equals . Az utolsó kódrészletben a példa a Browsable tulajdonságot használja az érték ellenőrzéséhez.

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

Ha az osztályt a BrowsableAttributekövetkezővel jelölte meg, az érték ellenőrzéséhez használja az alábbi kódot.

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

Megjegyzések

A vizualizációtervező általában az Tulajdonságok ablak azokat a tagokat jeleníti meg, amelyek nem rendelkeznek böngészhető attribútummal, vagy a BrowsableAttribute konstruktor browsable paramétere true értékre van állítva. Ezek a tagok a tervezéskor módosíthatók. A konstruktor BrowsableAttribute paraméterkészletével browsablefalse megjelölt tagok nem alkalmasak a tervezési idő szerkesztésére, ezért nem jelennek meg vizuális tervezőkben. Az alapértelmezett érték a true.

Note

Ha megjelöl egy tulajdonságot Browsable(true), az attribútum értéke az állandó tagra Yesvan állítva. A megjelölt Browsable(false)tulajdonság esetében az érték a következő No: . Ezért ha ellenőrzi ennek az attribútumnak az értékét a kódban, meg kell adnia az attribútumot BrowsableAttribute.YesBrowsableAttribute.No.

További információ: Attribútumok.

Konstruktorok

Name	Description
BrowsableAttribute(Boolean)	Inicializálja a BrowsableAttribute osztály új példányát.

Mezők

Name	Description
Default	Az alapértelmezett értéket adja meg a BrowsableAttribute( vagyis Yes) értékhez. Ez static a mező írásvédett.
No	Megadja, hogy egy tulajdonság vagy esemény nem módosítható a tervezéskor. Ez static a mező írásvédett.
Yes	Megadja, hogy egy tulajdonság vagy esemény a tervezéskor módosítható-e. Ez static a mező írásvédett.

Tulajdonságok

Name	Description
Browsable	Beolvas egy értéket, amely jelzi, hogy egy objektum böngészhető-e.
TypeId	Ha származtatott osztályban implementálják, ehhez egy egyedi azonosítót Attributekap. (Öröklődés forrása Attribute)

Metódusok

Name	Description
Equals(Object)	Azt jelzi, hogy ez a példány és egy megadott objektum egyenlő-e.
GetHashCode()	A példány kivonatkódját adja vissza.
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
IsDefaultAttribute()	Meghatározza, hogy ez az attribútum-e az alapértelmezett érték.
Match(Object)	Származtatott osztály felülírásakor egy olyan értéket ad vissza, amely jelzi, hogy ez a példány egy adott objektummal egyenlő-e. (Öröklődés forrása Attribute)
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)

Lásd még

• Attribute
• PropertyDescriptor
• EventDescriptor
• AttributeCollection
• PropertyDescriptorCollection