DebuggerTypeProxyAttribute Class

Article
01/16/2013

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Specifies the display proxy for a type.

Inheritance Hierarchy

System. . :: . .Object
System. . :: . .Attribute
System.Diagnostics..::..DebuggerTypeProxyAttribute

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Assembly Or AttributeTargets.Class Or AttributeTargets.Struct, AllowMultiple := True)> _
Public NotInheritable Class DebuggerTypeProxyAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Assembly|AttributeTargets.Class|AttributeTargets.Struct, AllowMultiple = true)]
public sealed class DebuggerTypeProxyAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Assembly|AttributeTargets::Class|AttributeTargets::Struct, AllowMultiple = true)]
public ref class DebuggerTypeProxyAttribute sealed : public Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Assembly|AttributeTargets.Class|AttributeTargets.Struct, AllowMultiple = true)>]
type DebuggerTypeProxyAttribute =  
    class
        inherit Attribute
    end

public final class DebuggerTypeProxyAttribute extends Attribute

The DebuggerTypeProxyAttribute type exposes the following members.

Constructors

	Name	Description
	DebuggerTypeProxyAttribute(String)	Initializes a new instance of the DebuggerTypeProxyAttribute class using the type name of the proxy.
	DebuggerTypeProxyAttribute(Type)	Initializes a new instance of the DebuggerTypeProxyAttribute class using the type of the proxy.

Top

Properties

	Name	Description
	ProxyTypeName	Gets the type name of the proxy type.
	Target	Gets or sets the target type for the attribute.
	TargetTypeName	Gets or sets the name of the target type.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Note Use this attribute when you need to significantly and fundamentally change the debugging view of a type, but not change the type itself.

The DebuggerTypeProxyAttribute attribute is used to specify a display proxy for a type, allowing a developer to tailor the view for the type. This attribute can be used at the assembly level as well, in which case the Target property specifies the type for which the proxy will be used. In general, this attribute specifies a private nested type that occurs within the type to which the attribute is applied. An expression evaluator that supports type viewers checks for this attribute when a type is displayed. If the attribute is found, the expression evaluator substitutes the display proxy type for the type the attribute is applied to.

When the DebuggerBrowsableAttribute is present, the debugger variable window displays only the public members of the proxy type. Private members are not displayed. The behavior of the data window is not changed by attribute-enhanced views.

To avoid unnecessary performance penalties, expression evaluators should not examine the attributes on the display proxy of the type unless the type is expanded, either through the user clicking the plus sign (+) next to the type in a data window, or through the application of the DebuggerBrowsableAttribute attribute. Therefore, it is recommended that no attributes be applied to the display type. Attributes can and should be applied within the body of the display type.

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.

Share via