This topic has not yet been rated - Rate this topic

SwitchAttribute Class

.NET Framework 4.5

Other Versions

Identifies a switch used in an assembly, class, or member.

Inheritance Hierarchy

System.Object
System.Attribute
System.Diagnostics.SwitchAttribute

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

Syntax

C++

[AttributeUsageAttribute(AttributeTargets.Assembly|AttributeTargets.Class|AttributeTargets.Constructor|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Event)]
public sealed class SwitchAttribute : Attribute

The SwitchAttribute type exposes the following members.

Constructors

	Name	Description
	SwitchAttribute	Initializes a new instance of the SwitchAttribute class, specifying the name and the type of the switch.

Top

Properties

	Name	Description
	SwitchDescription	Gets or sets the description of the switch.
	SwitchName	Gets or sets the display name of the switch.
	SwitchType	Gets or sets the type of the switch.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	GetAll	Returns all switch attributes for the specified assembly.
	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.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

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

Top

Remarks

A SwitchAttribute attribute can be used on an assembly, class, constructor, method, property, or event.

The SwitchAttribute attribute can be used by tools that inspect an assembly for configuration settings.

Examples

The following example shows how to use the SwitchAttribute attribute to identify the switch used in an assembly. This code example is part of a larger example provided for the TraceSource class.

[SwitchAttribute("SourceSwitch", typeof(SourceSwitch))]
static void Main()

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.

Reference

System.Diagnostics Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)