Struct RulerInfo

Ruler information

Namespace: Terminaux.Writer.CyclicWriters.Graphical.Rulers

Assembly: Terminaux.dll

Syntax

public struct RulerInfo

Constructors

RulerInfo(int, RulerOrientation, int, bool)

Makes a new ruler info struct

Declaration

public RulerInfo(int position, RulerOrientation orientation, int intersectionStop = 0, bool invertDirection = false)

Parameters

Type	Name	Description
int	position	Zero-based position of the ruler relative to the supported cyclic writer or its inside
RulerOrientation	orientation	Orientation of the ruler
int	intersectionStop	Stop level for intersections
bool	invertDirection	Whether to invert the rendering direction or not

Properties

IntersectionStop

Defines a stop level when defining intersections (skip n intersections)

Declaration

public int IntersectionStop { readonly get; set; }

Property Value

Type	Description
int

Remarks

If set to 0, no stops will occur. Otherwise, the renderer will render intersections a specified number of times.

InvertDirection

Whether to invert the rendering direction or not

Declaration

public bool InvertDirection { readonly get; set; }

Property Value

Type	Description
bool

Remarks

If Orientation is set to Horizontal, the renderer will render a ruler from the right to the left if inversion is enabled, or from the left to the right if inversion is disabled.
If Orientation is set to Vertical, the renderer will render a ruler from the bottom to the top if inversion is enabled, or from the top to the bottom if inversion is disabled.

Orientation

Orientation of the ruler

Declaration

public RulerOrientation Orientation { readonly get; set; }

Property Value

Type	Description
RulerOrientation

Position

Zero-based position of the ruler relative to the supported cyclic writer or its inside

Declaration

public int Position { readonly get; set; }

Property Value

Type	Description
int

Remarks

On Horizontal, the position refers to the horizontal position that determines a top position of a ruler relative to the enclosed cyclic writer or its inside
On Vertical, the position refers to the vertical position that determines a left position of a ruler relative to the enclosed cyclic writer or its inside