WebBrowsableAttribute Class
 

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

Namespace:   System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

SystemObject
   SystemAttribute
    System.Web.UI.WebControls.WebPartsWebBrowsableAttribute

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

Initializes a new instance of the WebBrowsableAttribute class with the property set to true.

System_CAPS_pubmethod WebBrowsableAttribute

Initializes a new instance of the WebBrowsableAttribute class with the specified value for the property.

NameDescription
System_CAPS_pubproperty

Gets a value indicating whether a PropertyGridEditorPart control should display a specific property of a Web Parts control.

System_CAPS_pubproperty

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

NameDescription
System_CAPS_pubmethod Equals

Returns a value that indicates whether this instance is equal to a specified object.(Overrides AttributeEquals.)

System_CAPS_pubmethod GetHashCode

Returns the hash code for the display name value.(Overrides AttributeGetHashCode.)

System_CAPS_pubmethod GetType

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

System_CAPS_pubmethod IsDefaultAttribute

Determines whether the current instance is set to the default value.(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

Represents an instance of the WebBrowsableAttribute class with the property set to the default value, which is false.

System_CAPS_pubfield System_CAPS_static No

Represents an instance of the WebBrowsableAttribute class with the property set to false.

System_CAPS_pubfield System_CAPS_static Yes

Represents an instance of the WebBrowsableAttribute class with the property set to true.

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

Exception Condition
AspNetHostingPermission

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

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.

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 JobTypeName UserJobType
{
  get
  {
    object o = ViewState["UserJobType"];
    if (o != null)
      return (JobTypeName)o;
    else
      return _userJobType;
  }

  set { _userJobType = (JobTypeName)value; }
}
<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
.NET Framework
Available since 2.0

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