PSHost User Interface Raw
PSHost User Interface Raw
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.
public abstract class PSHostRawUserInterface
type PSHostRawUserInterface = class
Public MustInherit Class PSHostRawUserInterface
It models an 2-dimensional grid of cells called a Buffer. A buffer has a visible rectangular region, called a window. Each cell of the grid has a character, a foreground color, and a background color. When the buffer has input focus, it shows a cursor positioned in one cell. Keystrokes can be read from the buffer and optionally echoed at the current cursor position.
|PSHostRawUserInterface() PSHostRawUserInterface() PSHostRawUserInterface()||
Protected constructor which does nothing. Provided per .Net design guidelines section 4.3.1
|BackgroundColor BackgroundColor BackgroundColor||
Gets or sets the color used to render the background behind characters on the screen buffer. Each character cell in the screen buffer can have a separate background color.
|BufferSize BufferSize BufferSize||
Gets or sets the current size of the screen buffer, measured in character cells.
|CursorPosition CursorPosition CursorPosition||
Gets or sets the cursor position in the screen buffer. The view window always adjusts it's location over the screen buffer such that the cursor is always visible.
|CursorSize CursorSize CursorSize||
Gets or sets the cursor size as a percentage 0..100.
|ForegroundColor ForegroundColor ForegroundColor||
Gets or sets the color used to render characters on the screen buffer. Each character cell in the screen buffer can have a separate foreground color.
|KeyAvailable KeyAvailable KeyAvailable||
A non-blocking call to examine if a keystroke is waiting in the input buffer.
|MaxPhysicalWindowSize MaxPhysicalWindowSize MaxPhysicalWindowSize||
Gets the largest window possible for the current font and display hardware, ignoring the current buffer dimensions. In other words, the dimensions of the largest window that could be rendered in the current display, if the buffer was at least as large.
|MaxWindowSize MaxWindowSize MaxWindowSize||
Gets the size of the largest window possible for the current buffer, current font, and current display hardware. The view window cannot be larger than the screen buffer or the current display (the display the window is rendered on).
|WindowPosition WindowPosition WindowPosition||
Gets or sets position of the view window relative to the screen buffer, in characters. (0,0) is the upper left of the screen buffer.
|WindowSize WindowSize WindowSize||
Gets or sets the current view window size, measured in character cells. The window size cannot be larger than the dimensions returned by MaxPhysicalWindowSize.
|WindowTitle WindowTitle WindowTitle||
Gets or sets the titlebar text of the current view window.