Class CliFrameArea

Namespace

ItTiger.TigerCli.Rendering

Assembly

ItTiger.TigerCli.dll

Describes a rectangular frame region owned by a CliGrid.

public class CliFrameArea

Inheritance

object

CliFrameArea

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

App code normally obtains a frame area through AddFrameArea(CliFrameJoinStyle, int, int, int, int, CliCharStyle?) and then adds horizontal, vertical, or outer frame segments before the grid is measured/rendered. Frame segments cannot be added after the grid's frame layout has been initialized.

Properties

CharStyle

Optional default character style for frame segments that do not specify one.

public CliCharStyle? CharStyle { get; init; }

Property Value

CliCharStyle?

ColumnCount

The number of columns in this area.

public int ColumnCount { get; }

Property Value

int

FirstColumn

The first grid column included in this area.

public int FirstColumn { get; init; }

Property Value

int

FirstRow

The first grid row included in this area.

public int FirstRow { get; init; }

Property Value

int

Grid

The grid that owns this frame area.

public CliGrid Grid { get; init; }

Property Value

CliGrid

JoinStyle

How mixed single/double junctions are resolved.

public CliFrameJoinStyle JoinStyle { get; init; }

Property Value

CliFrameJoinStyle

LastColumn

The last grid column included in this area.

public int LastColumn { get; init; }

Property Value

int

LastRow

The last grid row included in this area.

public int LastRow { get; init; }

Property Value

int

Lines

The frame line segments that will be applied during frame layout initialization.

public List<CliFrameLine> Lines { get; init; }

Property Value

List<CliFrameLine>

RowCount

The number of rows in this area.

public int RowCount { get; }

Property Value

int

Methods

AddBottomFrame(CliFrameSegment, CliCharStyle?)

Adds a bottom horizontal frame segment spanning the full area width.

public void AddBottomFrame(CliFrameSegment segmentStyle, CliCharStyle? charStyle = null)

Parameters

segmentStyle CliFrameSegment

charStyle CliCharStyle?

AddHorizontalFrame(int, int, int, CliFrameSegment, CliCharStyle?)

Adds a horizontal frame segment inside this area.

public void AddHorizontalFrame(int column, int row, int length, CliFrameSegment segmentStyle, CliCharStyle? charStyle = null)

Parameters

column int

row int

length int

segmentStyle CliFrameSegment

charStyle CliCharStyle?

Exceptions

ArgumentOutOfRangeException

The segment is outside this frame area or has a non-positive length.

TigerCliException

The frame layout has already been initialized.

AddLeftFrame(CliFrameSegment, CliCharStyle?)

Adds a left vertical frame segment spanning the full area height.

public void AddLeftFrame(CliFrameSegment segmentStyle, CliCharStyle? charStyle = null)

Parameters

segmentStyle CliFrameSegment

charStyle CliCharStyle?

AddOuterFrame(CliFrameSegment, CliCharStyle?)

Adds top, left, right, and bottom frame segments around the full area.

public void AddOuterFrame(CliFrameSegment segmentStyle, CliCharStyle? charStyle = null)

Parameters

segmentStyle CliFrameSegment

charStyle CliCharStyle?

AddRightFrame(CliFrameSegment, CliCharStyle?)

Adds a right vertical frame segment spanning the full area height.

public void AddRightFrame(CliFrameSegment segmentStyle, CliCharStyle? charStyle = null)

Parameters

segmentStyle CliFrameSegment

charStyle CliCharStyle?

AddTopFrame(CliFrameSegment, CliCharStyle?)

Adds a top horizontal frame segment spanning the full area width.

public void AddTopFrame(CliFrameSegment segmentStyle, CliCharStyle? charStyle = null)

Parameters

segmentStyle CliFrameSegment

charStyle CliCharStyle?

AddVerticalFrame(int, int, int, CliFrameSegment, CliCharStyle?)

Adds a vertical frame segment inside this area.

public void AddVerticalFrame(int column, int row, int length, CliFrameSegment segmentStyle, CliCharStyle? charStyle = null)

Parameters

column int

row int

length int

segmentStyle CliFrameSegment

charStyle CliCharStyle?

Exceptions

ArgumentOutOfRangeException

The segment is outside this frame area or has a non-positive length.

TigerCliException

The frame layout has already been initialized.