BrowsableAttribute Class
Specifies whether a property or event should be displayed in a Properties window.
Assembly: System (in System.dll)
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.
Note: |
|---|
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 Attributes Overview and Extending Metadata Using Attributes.
The following example marks a property as browsable.
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
If you marked a class with the BrowsableAttribute, use the following code to check the value.
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note: