BrowsableAttribute Třída

Definice

Určuje, zda má být vlastnost nebo událost zobrazena v okno Vlastnosti.Specifies whether a property or event should be displayed in a Properties window.

public ref class BrowsableAttribute sealed : Attribute
public sealed class BrowsableAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public sealed class BrowsableAttribute : Attribute
type BrowsableAttribute = class
    inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.All)>]
type BrowsableAttribute = class
    inherit Attribute
Public NotInheritable Class BrowsableAttribute
Inherits Attribute
Dědičnost
BrowsableAttribute
Atributy

Příklady

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

Další příklad ukazuje, jak zjistit hodnotu BrowsableAttribute pro MyProperty .The next example shows how to check the value of the BrowsableAttribute for MyProperty. Nejprve kód získá PropertyDescriptorCollection všechny vlastnosti objektu.First, the code gets a PropertyDescriptorCollection with all the properties for the object. V dalším kroku se do PropertyDescriptorCollection Get načte indexy kódu MyProperty .Next, the code indexes into the PropertyDescriptorCollection to get MyProperty. Pak vrátí atributy pro tuto vlastnost a uloží je v proměnné atributů.Then it returns the attributes for this property and saves them in the attributes variable.

V příkladu jsou dva různé způsoby kontroly hodnoty BrowsableAttribute .The example presents two different ways of checking the value of the BrowsableAttribute. Ve druhém fragmentu kódu příklad volá Equals metodu.In the second code fragment, the example calls the Equals method. V předchozím fragmentu kódu používá příklad Browsable vlastnost k kontrole hodnoty.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 

Pokud jste označili třídu pomocí BrowsableAttribute , použijte následující kód k zkontrolování hodnoty.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 

Poznámky

Vizuální Návrhář obvykle zobrazuje v okno Vlastnosti těch členů, kteří buď nemají žádný atribut Procházet, nebo jsou označeny BrowsableAttribute browsable parametrem konstruktoru nastaveným 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. Tyto členy lze upravit v době návrhu.These members can be modified at design time. Členy označené BrowsableAttribute browsable parametrem konstruktoru nastaveným na false nejsou vhodné pro úpravy v době návrhu, a proto se ve vizuálním návrháři nezobrazují.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. Výchozí formát je true.The default is true.

Poznámka

Když označíte vlastnost pomocí Browsable(true) , hodnota tohoto atributu je nastavena na konstantního člena Yes .When you mark a property with Browsable(true), the value of this attribute is set to the constant member Yes. Pro vlastnost označenou Browsable(false) parametr je hodnota No .For a property marked with Browsable(false), the value is No. Proto při kontrole hodnoty tohoto atributu v kódu, je nutné zadat atribut jako BrowsableAttribute.Yes nebo 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.

Další informace najdete v tématu atributy.For more information, see Attributes.

Konstruktory

BrowsableAttribute(Boolean)

Inicializuje novou instanci BrowsableAttribute třídy.Initializes a new instance of the BrowsableAttribute class.

Pole

Default

Určuje výchozí hodnotu pro BrowsableAttribute , což je Yes .Specifies the default value for the BrowsableAttribute, which is Yes. Toto static pole je jen pro čtení.This static field is read-only.

No

Určuje, že vlastnost nebo událost nelze upravovat v době návrhu.Specifies that a property or event cannot be modified at design time. Toto static pole je jen pro čtení.This static field is read-only.

Yes

Určuje, že vlastnost nebo událost lze upravovat v době návrhu.Specifies that a property or event can be modified at design time. Toto static pole je jen pro čtení.This static field is read-only.

Vlastnosti

Browsable

Získá hodnotu, která označuje, zda je objekt Procházet.Gets a value indicating whether an object is browsable.

TypeId

Při implementaci v odvozené třídě získá jedinečný identifikátor Attribute .When implemented in a derived class, gets a unique identifier for this Attribute.

(Zděděno od Attribute)

Metody

Equals(Object)

Udává, zda je tato instance totožná se zadaným objektem.Indicates whether this instance and a specified object are equal.

GetHashCode()

Vrátí hodnotu hash pro tuto instanci.Returns the hash code for this instance.

GetType()

Získá Type aktuální instanci.Gets the Type of the current instance.

(Zděděno od Object)
IsDefaultAttribute()

Určuje, zda je tento atribut výchozí.Determines if this attribute is the default.

IsDefaultAttribute()

Při přepsání v odvozené třídě označuje, zda je hodnota této instance výchozí hodnotou pro odvozenou třídu.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Zděděno od Attribute)
Match(Object)

Při přepsání v odvozené třídě vrátí hodnotu, která označuje, zda je tato instance rovna zadanému objektu.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Zděděno od Attribute)
MemberwiseClone()

Vytvoří kopii aktuálního seznamu Object .Creates a shallow copy of the current Object.

(Zděděno od Object)
ToString()

Vrátí řetězec, který představuje aktuální objekt.Returns a string that represents the current object.

(Zděděno od Object)

Explicitní implementace rozhraní

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

Mapuje sadu názvů na odpovídající sadu identifikátorů pro rozesílání.Maps a set of names to a corresponding set of dispatch identifiers.

(Zděděno od Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Načte informace o typu pro objekt, který lze použít k získání informací o typu pro rozhraní.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Zděděno od Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Získá počet rozhraní typu informací, které objekt poskytuje (0 nebo 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Zděděno od Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Poskytuje přístup k vlastnostem a metodám vystaveným objektem.Provides access to properties and methods exposed by an object.

(Zděděno od Attribute)

Platí pro

Viz také