Skip to content
ConsoleMonster
Class

ViewHint

ConsoleMonster.Widgets

Edit on GitHub
Namespace
ConsoleMonster.Widgets
Assembly
ConsoleMonster
Source
ViewHint.cs:13
Implements
IWidget
Modifiers
sealed

One consistent footer for omitted rows and hidden columns.

Inheritance

  • object
  • ViewHint

Usage

Explore 12 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 6

Accepted by parameters 6

Constructors

public ViewHint() #
ViewHint.cs:13

Methods

public Size Measure(Constraints constraints, RenderContext context) #
ViewHint.cs:25

Returns the size the widget wants within the constraints.

Parameters

constraints ConsoleMonster.Layout.Constraints required
The space offered.
context ConsoleMonster.Canvas.RenderContext required
Profile, theme and glyphs.

Returns

Size The desired size, never larger than the constraints.
public void Render(Region region, RenderContext context) #
ViewHint.cs:27

Renders into a region. The region may be smaller or larger than the measured size.

Parameters

region ConsoleMonster.Canvas.Region required
The target region.
context ConsoleMonster.Canvas.RenderContext required
Profile, theme and glyphs.

Properties

public long MoreRows { get; set; } #
ViewHint.cs:11

The number of additional rows.

public IList<string> Columns { get; } #
ViewHint.cs:13

Literal names of hidden columns.

Extension Methods

public static ViewHint AddColumn(ViewHint viewHint, string item) #

Adds an item to ViewHint.Columns: Literal names of hidden columns.

Parameters

viewHint ConsoleMonster.Widgets.ViewHint required
The instance.
item string required
The item.

Returns

ViewHint The same instance.
AddColumns 2 overloads
public static ViewHint AddColumns(ViewHint viewHint, params string[] items) #

Adds items to ViewHint.Columns: Literal names of hidden columns.

Parameters

viewHint ConsoleMonster.Widgets.ViewHint required
The instance.
items string[] required
The items, in order.

Returns

ViewHint The same instance.
public static ViewHint AddColumns(ViewHint viewHint, IEnumerable<string> items) #

Adds items to ViewHint.Columns: Literal names of hidden columns.

Parameters

viewHint ConsoleMonster.Widgets.ViewHint required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

ViewHint The same instance.
public static ViewHint MoreRows(ViewHint viewHint, long value) #

Sets ViewHint.MoreRows: The number of additional rows.

Parameters

viewHint ConsoleMonster.Widgets.ViewHint required
The instance.
value long required
The value.

Returns

ViewHint The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.ViewHint { MoreRows = value };    viewHint.MoreRows(value);