DebuggerBrowsableAttribute Class (System.Diagnostics)

Switch View :
ScriptFree
.NET Framework Class Library
DebuggerBrowsableAttribute Class

Determines if and how a member is displayed in the debugger variable windows. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  System.Attribute
    System.Diagnostics.DebuggerBrowsableAttribute

Namespace:  System.Diagnostics
Assembly:  mscorlib (in mscorlib.dll)
Syntax

Visual Basic
<ComVisibleAttribute(True)> _
<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field, AllowMultiple := False)> _
Public NotInheritable Class DebuggerBrowsableAttribute _
	Inherits Attribute
C#
[ComVisibleAttribute(true)]
[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = false)]
public sealed class DebuggerBrowsableAttribute : Attribute
Visual C++
[ComVisibleAttribute(true)]
[AttributeUsageAttribute(AttributeTargets::Property|AttributeTargets::Field, AllowMultiple = false)]
public ref class DebuggerBrowsableAttribute sealed : public Attribute
F#
[<Sealed>]
[<ComVisibleAttribute(true)>]
[<AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = false)>]
type DebuggerBrowsableAttribute =  
    class
        inherit Attribute
    end

The DebuggerBrowsableAttribute type exposes the following members.

Constructors

  Name Description
Public method DebuggerBrowsableAttribute Initializes a new instance of the DebuggerBrowsableAttribute class.
Top
Properties

  Name Description
Public property State Gets the display state for the attribute.
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods

  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
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 this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttribute When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
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
Explicit Interface Implementations

  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
Remarks

Note Note

In .NET Framework version 2.0, the DebuggerBrowsableAttribute class is not supported by Visual Basic. Using C#, you can add expansions for custom data using the DebuggerTypeProxyAttribute, DebuggerDisplayAttribute, and DebuggerBrowsableAttribute. Visual Basic supports the DebuggerDisplayAttribute attribute but not the DebuggerBrowsableAttribute attribute.

This attribute can be applied only as a single instance to properties and fields. It cannot be applied to assemblies.

The constructor for this attribute takes one of the DebuggerBrowsableState enumeration values, which specifies one of the following states:

  • Never indicates that the member is not displayed in the data window. For example, using this value for the DebuggerBrowsableAttribute on a field removes the field from the hierarchy; the field is not displayed when you expand the enclosing type by clicking the plus sign (+) for the type instance.

  • Collapsed indicates that the member is displayed but not expanded by default. This is the default behavior.

  • RootHidden indicates that the member itself is not shown, but its constituent objects are displayed if it is an array or collection.

For an example of the use of this attribute and the DebuggerDisplayAttribute and DebuggerTypeProxyAttribute attributes, see the example provided for the DebuggerDisplayAttribute class.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

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.
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.
See Also

Reference

Other Resources