BrowsableAttribute Třída

Definice

Obor názvů:

System.ComponentModel

Sestavení:

System.ComponentModel.Primitives.dll

Zdroj:

BrowsableAttribute.cs

Určuje, jestli se má v okno Vlastnosti zobrazit vlastnost nebo událost.

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

Dědičnost

Object

Attribute

BrowsableAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad označí vlastnost jako 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

Následující příklad ukazuje, jak zkontrolovat hodnotu BrowsableAttribute pro MyProperty. Kód nejprve získá se PropertyDescriptorCollection všemi vlastnostmi objektu . Dále se kód indexuje do objektu , PropertyDescriptorCollection aby získal MyProperty. Potom vrátí atributy pro tuto vlastnost a uloží je do proměnné attributes.

Příklad představuje dva různé způsoby kontroly hodnoty BrowsableAttribute. V druhém fragmentu kódu volá příklad metodu Equals . V posledním fragmentu kódu používá příklad Browsable ke kontrole hodnoty vlastnost .

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

Pokud jste označili třídu pomocí BrowsableAttribute, zkontrolujte hodnotu pomocí následujícího kódu.

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

Poznámky

Vizuální návrhář obvykle zobrazí v okno Vlastnosti ty členy, které buď nemají žádný prohlednutelný atribut, nebo jsou označeny parametrem BrowsableAttribute konstruktoru browsable nastaveným na true. Tyto členy lze upravit v době návrhu. Členy označené parametrem BrowsableAttribute konstruktoru browsable nastaveným na false nejsou vhodné pro úpravy v době návrhu, a proto nejsou zobrazeny ve vizuálním návrháři. Výchozí formát je true.

Poznámka

Když označíte vlastnost pomocí Browsable(true), hodnota tohoto atributu je nastavena na konstantní člen Yes. Pro vlastnost označenou Browsable(false)hodnotou je No. Proto při kontrole hodnoty tohoto atributu v kódu musíte zadat atribut jako BrowsableAttribute.Yes nebo BrowsableAttribute.No.

Další informace najdete v tématu Atributy.

Konstruktory

BrowsableAttribute(Boolean)

Inicializuje novou instanci BrowsableAttribute třídy .

Pole

Default	Určuje výchozí hodnotu pro BrowsableAttribute, což je Yes. Toto static pole je jen pro čtení.
No	Určuje, že vlastnost nebo událost nelze změnit v době návrhu. Toto static pole je jen pro čtení.
Yes	Určuje, že vlastnost nebo událost lze upravit v době návrhu. Toto static pole je jen pro čtení.

Vlastnosti

Browsable	Získá hodnotu označující, zda objekt je browsable.
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tuto Attributetřídu . (Zděděno od Attribute)

Metody

Equals(Object)	Udává, zda je tato instance totožná se zadaným objektem.
GetHashCode()	Vrátí hodnotu hash pro tuto instanci.
GetType()	Type Získá z aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Určuje, jestli je tento atribut výchozí.
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která označuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• Attribute
• PropertyDescriptor
• EventDescriptor
• AttributeCollection
• PropertyDescriptorCollection