Class HtmlSinkOptions

Namespace

ItTiger.TigerCli.Terminal

Assembly

ItTiger.TigerCli.dll

Options for HtmlSink. Defaults are conservative and documentation-friendly: output is wrapped in <pre class="tigercli">, links render as visible text (no anchors), and layout is unbounded (no emulated terminal width).

public sealed class HtmlSinkOptions

Inheritance

object

HtmlSinkOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

HyperlinkMode

How hyperlink targets are rendered. Defaults to Text.

public HtmlHyperlinkMode HyperlinkMode { get; init; }

Property Value

HtmlHyperlinkMode

SoftMaxWidth

Optional soft layout width in text columns — the HTML equivalent of a terminal width. When set, the sink reports it as SoftMaxWidth, so a grid measured against the sink wraps and truncates as if the terminal were this many columns wide. Defaults to null (unbounded), preserving the documentation-friendly "never wrap because of the sink" behavior.

Standard measure-pass resolution applies: a grid's own SoftMaxWidth takes precedence over the sink's, and an already-measured grid is rendered as measured (this value only affects the measure pass). It has no effect on segment-level helpers such as TigerConsole.MarkupToHtml, which perform no measure pass. Must be positive when set.

public int? SoftMaxWidth { get; init; }

Property Value

int?

WrapInPre

When true (default), the whole render is wrapped in <pre class="tigercli">…</pre> so whitespace and line breaks are preserved by the browser. When false, only the inner HTML is emitted (for embedding inside a caller-supplied container).

public bool WrapInPre { get; init; }

Property Value

bool