API Reference
InlineOutput
A live area of a few lines anchored below the cursor, in the normal screen (no alternate screen): the frame is redrawn in place, lines written during the session are inserted above it (so output and logs scroll by while the area stays at the bottom), and when the session ends the area is cleared so the final state can be printed into the scrollback (or left out for a transient area). Frames are as tall as the content, not the window.
Inheritance
- Object
- InlineOutput
Constructors
public InlineOutput(ITerminalWriter writer, TerminalProfile profile, Boolean ownsWriter = true) #Creates an inline output.
Parameters
- writer ConsoleMonster.Output.ITerminalWriter
- The terminal writer.
- profile ConsoleMonster.Capabilities.TerminalProfile
- The profile.
- ownsWriter System.Boolean = true
- Whether disposing the output disposes the writer.
Methods
public Void BeginLive() #VoidStarts live rendering (VT: alternate screen, hidden cursor). No effect for line-based outputs.
public Void Dispose() #VoidPerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public Void EndLive() #VoidEnds live rendering and restores the terminal (cursor, screen, attributes). Safe to call more than once.
public Void Invalidate() #VoidForces the next frame to be redrawn completely (after a resize or external output).
public Void RenderFrame(CellBuffer frame) #VoidDraws a full-screen frame, writing only the cells that changed since the previous frame.
Parameters
- frame ConsoleMonster.Canvas.CellBuffer
- The frame; its size is the screen size.
public Void WriteBlock(CellBuffer buffer) #VoidAppends a rendered block (print-once output) to the scrollback.
Parameters
- buffer ConsoleMonster.Canvas.CellBuffer
- The rendered block; trailing blank cells on each row are trimmed.
public Void WriteInline(StyledLine line) #VoidWrites one styled line without ending it (Write-ConsoleText -NoNewLine); the next write continues on it.
Parameters
- line ConsoleMonster.Text.StyledLine
- The line.
public Void WriteLine(StyledLine line) #VoidAppends one styled line (stream narration, captured output, summaries).
Parameters
- line ConsoleMonster.Text.StyledLine
- The line.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Boolean SupportsLiveFrames { get; } #Whether the output can redraw a live frame in place.