System.Management.Automation.Host Namespace

Classes

ChoiceDescription

Provides a description of a choice for use by .

FieldDescription

Provides a description of a field for use by Prompt(String, String, Collection<FieldDescription>).

HostException

Defines the exception thrown when the Host cannot complete an operation such as checking whether there is any input available.

PromptingException

Defines the exception thrown when an error occurs from prompting for a command parameter.

PSHost

Defines the properties and facilities providing by an application hosting an MSH Runspace.

PSHostRawUserInterface

Defines the lowest-level user interface functions that an interactive application hosting an MSH Runspace can choose to implement if it wants to support any cmdlet that does character-mode interaction with the user.

PSHostUserInterface

Defines the properties and facilities providing by an hosting application deriving from PSHost that offers dialog-oriented and line-oriented interactive features.

Structs

BufferCell

Represents a character, a foregroundColor color, and background color

Coordinates

Represents an (x,y) coordinate pair

KeyInfo

Represents information of a keystroke

Rectangle

Represents a rectangular region of the screen.

        <!--We use this structure instead of System.Drawing.Rectangle because S.D.R 
        is way overkill and would bring in another assembly.-->
Size

Represents a width and height pair

Interfaces

IHostSupportsInteractiveSession

This interface needs to be implemented by PSHost objects that want to support the PushRunspace and PopRunspace functionality.

IHostUISupportsMultipleChoiceSelection

This interface needs to be implemented by PSHost objects that want to support PromptForChoice by giving the user ability to select more than one choice. The PromptForChoice method available in PSHostUserInterface class supports only one choice selection.

Enums

BufferCellType

Defines three types of BufferCells to accommodate for hosts that use up to two cells to display a character in some languages such as Chinese and Japanese.

ControlKeyStates

Defines the states of Control Key

ReadKeyOptions

Governs the behavior of ReadKey() and ReadKey(ReadKeyOptions)