.NET Framework Class Library
WebBrowsableAttribute Class

Indicates whether the designated property of a Web Parts control is displayed in a PropertyGridEditorPart object.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Web.UI.WebControls.WebPartsWebBrowsableAttribute

Namespace:   System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)
Syntax
<[%$TOPIC/x87y73ek_en-us_VS_110_3_0_0_0_0%]([%$TOPIC/x87y73ek_en-us_VS_110_3_0_0_0_1%].Property)> _
Public NotInheritable Class WebBrowsableAttribute _
	Inherits [%$TOPIC/x87y73ek_en-us_VS_110_3_0_0_0_2%]
[[%$TOPIC/x87y73ek_en-us_VS_110_3_0_1_0_0%]([%$TOPIC/x87y73ek_en-us_VS_110_3_0_1_0_1%].Property)]
public sealed class WebBrowsableAttribute : [%$TOPIC/x87y73ek_en-us_VS_110_3_0_1_0_2%]
[[%$TOPIC/x87y73ek_en-us_VS_110_3_0_2_0_0%]([%$TOPIC/x87y73ek_en-us_VS_110_3_0_2_0_1%]::Property)]
public ref class WebBrowsableAttribute sealed : public [%$TOPIC/x87y73ek_en-us_VS_110_3_0_2_0_2%]
[<[%$TOPIC/x87y73ek_en-us_VS_110_3_0_3_0_0%]>]
[<[%$TOPIC/x87y73ek_en-us_VS_110_3_0_3_0_1%]([%$TOPIC/x87y73ek_en-us_VS_110_3_0_3_0_2%].Property)>]
type WebBrowsableAttribute =  
    class 
        inherit [%$TOPIC/x87y73ek_en-us_VS_110_3_0_3_0_3%] 
    end

The WebBrowsableAttribute type exposes the following members.

Constructors
  NameDescription
Public method WebBrowsableAttributeInitializes a new instance of the WebBrowsableAttribute class with the Browsable property set to true.
Public method WebBrowsableAttribute(Boolean)Initializes a new instance of the WebBrowsableAttribute class with the specified value for the Browsable property.
Top
Properties
  NameDescription
Public property BrowsableGets a value indicating whether a PropertyGridEditorPart control should display a specific property of a Web Parts control.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsReturns a value that indicates whether this instance is equal to a specified object. (Overrides AttributeEquals(Object).)
Public method GetHashCodeReturns the hash code for the display name value. (Overrides AttributeGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeDetermines whether the current instance is set to the default value. (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 DefaultRepresents an instance of the WebBrowsableAttribute class with the Browsable property set to the default value, which is false.
Public field Static member NoRepresents an instance of the WebBrowsableAttribute class with the Browsable property set to false.
Public field Static member YesRepresents an instance of the WebBrowsableAttribute class with the Browsable property set to true.
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
Exceptions
ExceptionCondition
AspNetHostingPermission

for operating in a hosted environment. Demand value: LinkDemand; Permission value: Minimal.

Remarks

The PropertyGridEditorPart control provides a generic user interface (UI) that enables users to edit custom properties on WebPart and server controls placed in WebPartZoneBase zones. The editing UI is provided for properties that are marked in the source code with the WebBrowsable attribute (from the WebBrowsableAttribute class). When a property is marked with this attribute, a PropertyGridEditorPart control creates the editing UI based on the type of the property, and uses a PropertyDescriptor object if needed to convert the value in each editing control to the type of the property.

Examples

The following code example demonstrates how to use the WebBrowsableAttribute attribute to mark a property on a Web Parts control as available to be displayed in a PropertyGridEditorPart control. This example is part of a larger example found in the PropertyGridEditorPart class overview.

<Personalizable(), WebBrowsable(), WebDisplayName("Job Type"), _
  WebDescription("Select the category that corresponds to your job.")> _
Public Property UserJobType() As JobTypeName
  Get 
    Dim o As Object = ViewState("UserJobType")
    If Not (o Is Nothing) Then 
      Return CType(o, JobTypeName)
    Else 
      Return _userJobType
    End If 
  End Get 
  Set(ByVal value As JobTypeName)
    _userJobType = CType(value, JobTypeName)
  End Set 
End Property
[Personalizable(), WebBrowsable(), WebDisplayName("Job Type"), 
  WebDescription("Select the category that corresponds to your job.")]
public JobTypeName UserJobType
{
  get
  {
    object o = ViewState["UserJobType"];
    if (o != null)
      return (JobTypeName)o;
    else 
      return _userJobType;
  }

  set { _userJobType = (JobTypeName)value; }
}
Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0
Platforms

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.