DebuggerDisplayAttribute Class
Determines how a class or field is displayed in the debugger variable windows.
Assembly: mscorlib (in mscorlib.dll)
[ComVisibleAttribute(true)] [AttributeUsageAttribute(AttributeTargets::Assembly|AttributeTargets::Class|AttributeTargets::Struct|AttributeTargets::Enum|AttributeTargets::Property|AttributeTargets::Field|AttributeTargets::Delegate, AllowMultiple = true)] public ref class DebuggerDisplayAttribute sealed : public Attribute
The DebuggerDisplayAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | DebuggerDisplayAttribute | Initializes a new instance of the DebuggerDisplayAttribute class. |
| Name | Description | |
|---|---|---|
![]() | Name | Gets or sets the name to display in the debugger variable windows. |
![]() | Target | Gets or sets the type of the attribute's target. |
![]() | TargetTypeName | Gets or sets the type name of the attribute's target. |
![]() | Type | Gets or sets the string to display in the type column of the debugger variable windows. |
![]() | TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
![]() | Value | Gets the string to display in the value column of the debugger variable windows. |
| Name | Description | |
|---|---|---|
![]() | Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | 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.) |
![]() | Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() ![]() | _Attribute::GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
![]() ![]() | _Attribute::GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
![]() ![]() | _Attribute::GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
![]() ![]() | _Attribute::Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
The DebuggerDisplayAttribute constructor has a single argument: a string to be displayed in the value column for instances of the type. This string can contain braces ({ and }). The text within a pair of braces is evaluated as the name of a field, property, or method. For example, the following C# code causes "Count = 4" to be displayed when the plus sign (+) is selected to expand the debugger display for an instance of MyHashtable.
[DebuggerDisplay("Count = {count}")]
class MyHashtable
{
public int count = 4;
}
For information about using this attribute in Visual Studio, see Using DebuggerDisplay Attribute.
View the following example in Visual Studio to see the results of applying the DebuggerDisplayAttribute.
using namespace System; using namespace System::Collections; using namespace System::Diagnostics; using namespace System::Reflection; ref class HashtableDebugView; [DebuggerDisplay("{value}", Name = "{key}")] ref class KeyValuePairs { private: IDictionary^ dictionary; Object^ key; Object^ value; public: KeyValuePairs(IDictionary^ dictionary, Object^ key, Object^ value) { this->value = value; this->key = key; this->dictionary = dictionary; } }; [DebuggerDisplay("Count = {Count}")] [DebuggerTypeProxy(HashtableDebugView::typeid)] ref class MyHashtable : Hashtable { private: static const String^ TestString = "This should not appear in the debug window."; internal: ref class HashtableDebugView { private: Hashtable^ hashtable; public: static const String^ TestString = "This should appear in the debug window."; HashtableDebugView(Hashtable^ hashtable) { this->hashtable = hashtable; } [DebuggerBrowsable(DebuggerBrowsableState::RootHidden)] property array<KeyValuePairs^>^ Keys { array<KeyValuePairs^>^ get() { array<KeyValuePairs^>^ keys = gcnew array<KeyValuePairs^>(hashtable->Count); IEnumerator^ ie = hashtable->Keys->GetEnumerator(); int i = 0; Object^ key; while (ie->MoveNext()) { key = ie->Current; keys[i] = gcnew KeyValuePairs(hashtable, key, hashtable[key]); i++; } return keys; } } }; }; public ref class DebugViewTest { private: // The following constant will appear in the debug window for DebugViewTest. static const String^ TabString = " "; public: // The following DebuggerBrowsableAttribute prevents the property following it // from appearing in the debug window for the class. [DebuggerBrowsable(DebuggerBrowsableState::Never)] static String^ y = "Test String"; static void Main() { MyHashtable^ myHashTable = gcnew MyHashtable(); myHashTable->Add("one", 1); myHashTable->Add("two", 2); Console::WriteLine(myHashTable->ToString()); Console::WriteLine("In Main."); } }; int main() { DebugViewTest::Main(); }
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.
