Windows desktop applications
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

PSHostUserInterface Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Defines the custom host functionality that is used to perform dialog-oriented and line-oriented interaction, such as writing to, prompting for, and reading from user input.

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

System.Object
  System.Management.Automation.Host.PSHostUserInterface

public abstract class PSHostUserInterface

NameDescription
System_CAPS_protmethodPSHostUserInterface()

Initializes a new instance of the PSHostUserInterface class. Derived classes typically call this constructor (directly or implicitly) from their own constructors.

NameDescription
System_CAPS_pubpropertyRawUI

Gets an instance of the PSHostRawUserInterface interface that is implemented by the host application. This interface defines the low-level functionality of the custom host.

System_CAPS_pubpropertySupportsVirtualTerminal

Returns true for hosts that support VT100 like virtual terminals.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodPrompt(String, String, Collection<FieldDescription>)

When overridden in a derived class, prompts the user for input.

System_CAPS_pubmethodPromptForChoice(String, String, Collection<ChoiceDescription>, Int32)

When overridden in a derived class, provides a set of choices that enable the user to choose a single option from a set of options.

System_CAPS_pubmethodPromptForCredential(String, String, String, String)

When overridden in a derived class, prompts the user for credentials with a specified prompt window caption, prompt message, user name, and target name.

System_CAPS_pubmethodPromptForCredential(String, String, String, String, PSCredentialTypes, PSCredentialUIOptions)

When overridden in a derived class, prompts the user for credentials by using a specified prompt window caption, prompt message, user name and target name, credential types allowed to be returned, and UI behavior options.

System_CAPS_pubmethodReadLine()

When overridden in a derived class, reads characters that are entered by the user until a newline (carriage return) character is encountered.

System_CAPS_pubmethodReadLineAsSecureString()

When overridden in a derived class, reads characters entered by the user until a newline (carriage return) character is encountered and returns the characters as a secure string.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodWrite(ConsoleColor, ConsoleColor, String)

When overridden in a derived class, writes characters to the output display of the host with possible foreground and background colors.

System_CAPS_pubmethodWrite(String)

When overridden in a derived class, writes characters to the output display of the host.

System_CAPS_pubmethodWriteDebugLine(String)

When overridden in a derived class, displays a debug message to the user.

System_CAPS_pubmethodWriteErrorLine(String)

When overridden in a derived class, writes a line to the error display of the host.

System_CAPS_pubmethodWriteInformation(InformationRecord)

Invoked by WriteInformation to give the host a chance to intercept informational messages. These should not be displayed to the user by default, but may be useful to display in a separate area of the user interface.

System_CAPS_pubmethodWriteLine()

Writes a new line character (carriage return) to the output display of the host.

System_CAPS_pubmethodWriteLine(ConsoleColor, ConsoleColor, String)

Writes a line of characters to the output display of the host with foreground and background colors and appends a newline (carriage return) character.

System_CAPS_pubmethodWriteLine(String)

When overridden in a derived class, writes a line of characters to the output display of the host and appends a newline (carriage return) character.

System_CAPS_pubmethodWriteProgress(Int64, ProgressRecord)

When overridden in a derived class, writes a progress report to be displayed to the user.

System_CAPS_pubmethodWriteVerboseLine(String)

When overridden in a derived class, writes a verbose line to be displayed to the user.

System_CAPS_pubmethodWriteWarningLine(String)

When overridden in a derived class, writes a warning line to be displayed to the user.

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:
© 2016 Microsoft