ChoiceDescription Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Defines a choice that can be presented to the user by the host interface, such as Yes to &All.

Namespace:   System.Management.Automation.Host
Assembly:  System.Management.Automation (in System.Management.Automation.dll)

System.Object
  System.Management.Automation.Host.ChoiceDescription

public sealed class ChoiceDescription

NameDescription
System_CAPS_pubmethodChoiceDescription(String)

Creates a new ChoiceDescription that contains the text of the choice.

System_CAPS_pubmethodChoiceDescription(String, String)

Creates a new ChoiceDescription object that contains the text of the choice and a Help message for the choice.

NameDescription
System_CAPS_pubpropertyHelpMessage

Gets and sets the Help message for this choice.

System_CAPS_pubpropertyLabel

Gets the text that is displayed for the choice.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

The following methods can be implemented in the host user interface to provide a prompt that displays choices that can be selected by the user.

PSHostUserInterface.PromptForChoice

This method allows the user to select a single choice from the displayed prompt.

IHostUISupportsMultipleChoiceSelection.PromptForChoice

This method allows the user to select multiple choices from the displayed prompt.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: