FieldDescription.Label Property

Definition

Namespace:

System.Management.Automation.Host

Assembly:

System.Management.Automation.dll

Package:

System.Management.Automation v7.4.0

A short, human-presentable message to describe and identify the field. If supplied, a typical implementation of Prompt(String, String, Collection<FieldDescription>) will use this value instead of the field name to identify the field to the user.

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

public:
 property Platform::String ^ Label { Platform::String ^ get(); void set(Platform::String ^ value); };

public string Label { get; set; }

member this.Label : string with get, set

Public Property Label As String

Property Value

String

Exceptions

PSArgumentNullException

set to null.

Remarks

Note that the special character & (ampersand) may be embedded in the label string to identify the next character in the label as a "hot key" (aka "keyboard accelerator") that the Prompt(String, String, Collection<FieldDescription>) implementation may use to allow the user to quickly set input focus to this field. The implementation of Prompt(String, String, Collection<FieldDescription>) is responsible for parsing the label string for this special character and rendering it accordingly.

For example, a field named "SSN" might have "&Social Security Number" as it's label.

If no label is set, then the empty string is returned.