BrowsableAttribute Class
Collapse the table of content
Expand the table of content

BrowsableAttribute Class


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

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)


public sealed class BrowsableAttribute : Attribute


Initializes a new instance of the BrowsableAttribute class.


Gets a value indicating whether an object is browsable.


When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)


Indicates whether this instance and a specified object are equal.(Overrides Attribute.Equals(Object).)


Returns the hash code for this instance.(Overrides Attribute.GetHashCode().)


Gets the Type of the current instance.(Inherited from Object.)


Determines if this attribute is the default.(Overrides Attribute.IsDefaultAttribute().)


When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)


Returns a string that represents the current object.(Inherited from Object.)


Specifies the default value for the BrowsableAttribute, which is Yes. This static field is read-only.


Specifies that a property or event cannot be modified at design time. This static field is read-only.


Specifies that a property or event can be modified at design time. This static field is read-only.

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

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)


Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

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.


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 BrowsableAttribute.Yes or BrowsableAttribute.No.

For more information, see Extending Metadata Using Attributes.

The following example marks a property as browsable.

 public int MyProperty {
    get {
       // Insert code here.
       return 0;
    set {
       // 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.
 AttributeCollection 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 = 
 if(myAttribute.Browsable) {
    // Insert code here.

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

AttributeCollection attributes = 
 if(attributes[typeof(BrowsableAttribute)].Equals(BrowsableAttribute.Yes)) {
    // Insert code here.

.NET Framework
Available since 1.1
Available since 4.0
Windows Phone Silverlight
Available since 7.1

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

Return to top
© 2015 Microsoft