PSHostRawUserInterface Members

Defines the low-level host functionality, such as read and write actions, that a host application can implement to support cmdlets that perform character-mode interaction with the user.

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

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

  Name Description
public property BackgroundColor Gets or sets the background color of the displayed text.
public property BufferSize Gets or sets the current size of the screen buffer.
public property CursorPosition Gets or sets the cursor position in the screen buffer.
public property CursorSize Gets or sets the cursor size as a percentage of a buffer cell.
public property ForegroundColor Gets or sets the foreground color of the displayed text.
public property KeyAvailable Gets a value that indicates whether the user has pressed a key.
public property MaxPhysicalWindowSize Gets the dimensions of the largest window that could be rendered in the current display, if the buffer was at the least that large.
public property MaxWindowSize Gets the size of the largest window possible for the current buffer, current font, and current display hardware.
public property WindowPosition Gets or sets the position, in characters, of the view window relative to the screen buffer.
public property WindowSize Gets or sets the current size of the view window.
public property WindowTitle Gets or sets the title bar text of the current view window.
Top

(see also Protected Methods)
 NameDescription
public methodEquals  (Inherited from Object)
public methodFlushInputBufferWhen overridden in a derived class, flushes the input buffer. All input currently in the buffer is discarded.
public methodGetBufferContentsWhen overridden in a derived class, retrieves a rectangular region of the screen buffer.
public methodGetHashCode  (Inherited from Object)
public methodGetType  (Inherited from Object)
public methodLengthInBufferCellsOverloaded. Determines the number of buffer cells occupied by a character or string. The variants of this method can determine the number of cells occupied by a character, a string, or a part of a string.
public methodNewBufferCellArrayOverloaded. Creates a two-dimensional array of buffer cells. The variants of this method can build the array based on array size and character, based on a specified width, height, and character, and based on a set of supplied characters.
public methodReadKeyOverloaded. Reads a key from the keyboard device. The variants of this method can read the key with or without required keystroke options.
public methodScrollBufferContentsWhen overridden in a derived class, crops a region of the screen buffer.
public methodSetBufferContentsOverloaded. Copies characters to the screen buffer. The variants of this method can be used to fill the buffer with an array of buffer cells or fill a specific region with a single character.
public methodToString  (Inherited from Object)
Top

(see also Extension Methods)
 NameDescription
protected methodFinalize  (Inherited from Object)
protected methodMemberwiseClone  (Inherited from Object)
Top

  Name Description
public extension method As  Use this method to adapt an object from a foreign app domain to a known interface in this app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method As  This is called to adapt an object from a foreign app domain to a known interface in this appDomainThis element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method As  Adapts an object from a foreign app domain to a known interface in this app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method Extend  Use this method to adapt and extend an object so that you can pass it to a foreign app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method Extend  This is called to adapt and extend an object that we wish to pass to a foreign app domainThis element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method Extend  Used to extend an object with an interface from a foreign app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method ToEnumerable  This element is introduced in Windows PowerShell 5.0. (Defined by CollectionExtensions.)
Top


Show: