Struct RulerInfo

Ruler information

Namespace

Terminaux.Writer.CyclicWriters.Graphical.Rulers @ 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

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

Properties

IntersectionStop

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

Remarks

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

Property Value

int

Declaration

public int IntersectionStop { readonly get; set; }

InvertDirection

Whether to invert the rendering direction or not

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.

Property Value

bool

Declaration

public bool InvertDirection { readonly get; set; }

Orientation

Orientation of the ruler

Property Value

RulerOrientation

Declaration

public RulerOrientation Orientation { readonly get; set; }

Position

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

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

Property Value

int

Declaration

public int Position { readonly get; set; }