BrowsableAttribute Class
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

SystemObject
   SystemAttribute
    System.ComponentModelBrowsableAttribute

[AttributeUsageAttribute(AttributeTargets.All)]
public sealed class BrowsableAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::All)]
public ref class BrowsableAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.All)>]
type BrowsableAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.All)>
Public NotInheritable Class BrowsableAttribute
	Inherits Attribute
NameDescription
System_CAPS_pubmethod BrowsableAttribute

Initializes a new instance of the BrowsableAttribute class.

NameDescription
System_CAPS_pubproperty

Gets a value indicating whether an object is browsable.

System_CAPS_pubproperty

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

NameDescription
System_CAPS_pubmethod Equals

Indicates whether this instance and a specified object are equal.(Overrides AttributeEquals.)

System_CAPS_pubmethod GetHashCode

Returns the hash code for this instance.(Overrides AttributeGetHashCode.)

System_CAPS_pubmethod GetType

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

System_CAPS_pubmethod IsDefaultAttribute

Determines if this attribute is the default.(Overrides AttributeIsDefaultAttribute.)

System_CAPS_pubmethod Match

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

System_CAPS_pubmethod ToString

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

NameDescription
System_CAPS_pubfield System_CAPS_static Default

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

System_CAPS_pubfield System_CAPS_static No

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

System_CAPS_pubfield System_CAPS_static Yes

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

NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

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

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

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

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

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

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

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.

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

The following example marks a property as browsable.

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

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 
AttributeCollection^ attributes = TypeDescriptor::GetAttributes( MyProperty );
if ( attributes[ BrowsableAttribute::typeid ]->Equals( BrowsableAttribute::Yes ) )
{
   // Insert code here.
}
.NET Framework
Available since 1.1
Silverlight
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