.NET Framework Class Library
BrowsableAttribute Class

Specifies whether a property or event should be displayed in a Properties window.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModelBrowsableAttribute

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/6bffwzcf_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/6bffwzcf_en-us_VS_110_2_0_0_0_1%].All)> _
Public NotInheritable Class BrowsableAttribute _
	Inherits [%$TOPIC/6bffwzcf_en-us_VS_110_2_0_0_0_2%]
[[%$TOPIC/6bffwzcf_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/6bffwzcf_en-us_VS_110_2_0_1_0_1%].All)]
public sealed class BrowsableAttribute : [%$TOPIC/6bffwzcf_en-us_VS_110_2_0_1_0_2%]
[[%$TOPIC/6bffwzcf_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/6bffwzcf_en-us_VS_110_2_0_2_0_1%]::All)]
public ref class BrowsableAttribute sealed : public [%$TOPIC/6bffwzcf_en-us_VS_110_2_0_2_0_2%]
[<[%$TOPIC/6bffwzcf_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/6bffwzcf_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/6bffwzcf_en-us_VS_110_2_0_3_0_2%].All)>]
type BrowsableAttribute =  
    class 
        inherit [%$TOPIC/6bffwzcf_en-us_VS_110_2_0_3_0_3%] 
    end

The BrowsableAttribute type exposes the following members.

Constructors
  NameDescription
Public method BrowsableAttributeInitializes a new instance of the BrowsableAttribute class.
Top
Properties
  NameDescription
Public property BrowsableGets a value indicating whether an object is browsable.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsIndicates whether this instance and a specified object are equal. (Overrides AttributeEquals(Object).)
Public method GetHashCodeReturns the hash code for this instance. (Overrides AttributeGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeDetermines if this attribute is the default. (Overrides AttributeIsDefaultAttribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Fields
  NameDescription
Public field Static member DefaultSpecifies the default value for the BrowsableAttribute, which is Yes. This static field is read-only.
Public field Static member NoSpecifies that a property or event cannot be modified at design time. This static field is read-only.
Public field Static member YesSpecifies that a property or event can be modified at design time. This static field is read-only.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

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. These members can be modified at design time. 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. The default is true.

NoteNote

When you mark a property with Browsable(true), the value of this attribute is set to the constant member Yes. For a property marked with Browsable(false), the value is No. Therefore, when you check the value of this attribute in your code, you must specify the attribute as BrowsableAttributeYes or BrowsableAttributeNo.

For more information, see Extending Metadata Using Attributes.

Examples

The following example marks a property as browsable.


<Browsable(True)> _
Public Property MyProperty() As Integer 
    Get 
        ' Insert code here. 
        Return 0
    End Get 
    Set 
        ' Insert code here. 
    End Set  
End Property
[Browsable(true)]
 public int MyProperty {
    get {
       // Insert code here. 
       return 0;
    }
    set {
       // Insert code here.
    }
 }
public:
   [Browsable(true)]
   property int MyProperty 
   {
      int get()
      {
         // Insert code here. 
         return 0;
      }
      void set( int value )
      {
         // Insert code here.
      }
   }

The next example shows how to check the value of the BrowsableAttribute for MyProperty. First, the code gets a PropertyDescriptorCollection with all the properties for the object. Next, the code indexes into the PropertyDescriptorCollection to get MyProperty. Then it returns the attributes for this property and saves them in the attributes variable.

The example presents two different ways of checking the value of the BrowsableAttribute. In the second code fragment, the example calls the Equals method. In the last code fragment, the example uses the Browsable property to check the value.

' 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
// 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.
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.
}

If you marked a class with the BrowsableAttribute, use the following code to check the value.

Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(MyProperty)
If attributes(GetType(BrowsableAttribute)).Equals(BrowsableAttribute.Yes) Then 
    ' Insert code here. 
End If
AttributeCollection attributes = 
    TypeDescriptor.GetAttributes(MyProperty);
 if(attributes[typeof(BrowsableAttribute)].Equals(BrowsableAttribute.Yes)) {
    // Insert code here.
 }
AttributeCollection^ attributes = TypeDescriptor::GetAttributes( MyProperty );
if ( attributes[ BrowsableAttribute::typeid ]->Equals( BrowsableAttribute::Yes ) )
{
   // Insert code here.
}
Version Information

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1
Platforms

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.