This topic has not yet been rated - Rate this topic

WebBrowsableAttribute Class

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

System.Object
  System.Attribute
    System.Web.UI.WebControls.WebParts.WebBrowsableAttribute

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)
[AttributeUsageAttribute(AttributeTargets.Property)]
public sealed class WebBrowsableAttribute : Attribute

The WebBrowsableAttribute type exposes the following members.

  Name Description
Public method WebBrowsableAttribute() Initializes 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
  Name Description
Public property Browsable Gets a value indicating whether a PropertyGridEditorPart control should display a specific property of a Web Parts control.
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
  Name Description
Public method Equals Returns a value that indicates whether this instance is equal to a specified object. (Overrides Attribute.Equals(Object).)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for the display name value. (Overrides Attribute.GetHashCode().)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttribute Determines whether the current instance is set to the default value. (Overrides Attribute.IsDefaultAttribute().)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public field Static member Default Represents an instance of the WebBrowsableAttribute class with the Browsable property set to the default value, which is false.
Public field Static member No Represents an instance of the WebBrowsableAttribute class with the Browsable property set to false.
Public field Static member Yes Represents an instance of the WebBrowsableAttribute class with the Browsable property set to true.
Top
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo Retrieves 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 _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
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; }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ