PSHostUserInterface Members

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.

The following tables list the members exposed by the PSHostUserInterface type.

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

  Name Description
public property RawUI 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.
Top

(see also Protected Methods)
 NameDescription
public methodEquals  (Inherited from Object)
public methodGetHashCode  (Inherited from Object)
public methodGetType  (Inherited from Object)
public methodPromptWhen overridden in a derived class, prompts the user for input.
public methodPromptForChoiceWhen overridden in a derived class, provides a set of choices that enable the user to choose a single option from a set of options.
public methodPromptForCredentialOverloaded. When overridden in a derived class, prompts the user for credentials for a specified target. The variants of this method can be used to prompt the user with a specified prompt window caption, prompt message, user and target name, credential types allowed to be returned, and user interface (UI) behavior options.
public methodReadLineWhen overridden in a derived class, reads characters that are entered by the user until a newline (carriage return) character is encountered.
public methodReadLineAsSecureStringWhen 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.
public methodToString  (Inherited from Object)
public methodWriteOverloaded.  
public methodWriteDebugLineWhen overridden in a derived class, displays a debug message to the user.
public methodWriteErrorLineWhen overridden in a derived class, writes a line to the error display of the host.
public methodWriteLineOverloaded. Writes a line of characters with a newline (carriage return) character to the screen buffer. The variants of this method can write a carriage return, write a line of characters with an appended carriage return, and write a line of characters with foreground and background colors with an appended carriage return.
public methodWriteProgressWhen overridden in a derived class, writes a progress report to be displayed to the user.
public methodWriteVerboseLineWhen overridden in a derived class, writes a verbose line to be displayed to the user.
public methodWriteWarningLineWhen overridden in a derived class, writes a warning line to be displayed to the user.
Top

  Name Description
protected method Finalize  (Inherited from Object)
protected method MemberwiseClone  (Inherited from Object)
Top

Send comments about this topic to Microsoft.
Show:
© 2014 Microsoft