SwitchAttribute.SwitchName Property

Definition

Namespace:

System.Diagnostics

Assembly:

System.Diagnostics.TraceSource.dll

Source:

SwitchAttribute.cs

Gets or sets the display name of the switch.

public:
 property System::String ^ SwitchName { System::String ^ get(); void set(System::String ^ value); };

public string SwitchName { get; set; }

member this.SwitchName : string with get, set

Public Property SwitchName As String

Property Value

String

The display name of the switch.

Exceptions

ArgumentNullException

SwitchName is set to null.

ArgumentException

SwitchName is set to an empty string.

Examples

The following code example displays the value the SwitchName property for all switches used in an assembly. This code example is part of a larger example provided for the TraceSource class.

SwitchAttribute[] switches = SwitchAttribute.GetAll(typeof(TraceTest).Assembly);
for (int i = 0; i < switches.Length; i++)
{
    Console.WriteLine("Switch name = " + switches[i].SwitchName);
    Console.WriteLine("Switch type = " + switches[i].SwitchType);
}

Dim switches As SwitchAttribute() = SwitchAttribute.GetAll(GetType(TraceTest).Assembly)
Dim i As Integer
For i = 0 To switches.Length - 1
    Console.WriteLine("Switch name = " + switches(i).SwitchName.ToString())
    Console.WriteLine("Switch type = " + switches(i).SwitchType.ToString())
Next i

Remarks

The SwitchName property should match the DisplayName property of the switch.