ArionCaret class Core

How a text caret blinks - every caret of the library: board text boxes, the text area, the grid's filter box and cell editor, the text fields of panes. It follows the operating system's caret setting, not "reduce motion" (ArionMotion.Reduce): a blinking caret is how a user finds the insertion point, and the system has its own switch for it.

Read once from the operating system (on Windows the caret blink rate of the keyboard settings, elsewhere ArionCaret.DefaultBlinkMs); an application may set ArionCaret.BlinkMs itself, best before the first window opens: a grid takes the blink time when it is made, a board surface when a caret starts blinking. A steady caret applies everywhere with the next phase.

public static class ArionCaret
Namespace
ArionUI.Core
Package
ArionUI.Core · dotnet add package ArionUI.Core --prerelease

Fields

DefaultBlinkMs

public const int DefaultBlinkMs = 530;

Half a blink period where the platform has no setting of its own.

Properties

BlinkMs

public static int BlinkMs { get; set; }

Half a blink period in milliseconds - how long the caret is on, and then off; Timeout.Infinite keeps it on without blinking.

Exceptions

ArgumentOutOfRangeException

Neither positive nor Timeout.Infinite.

public static bool Blinks { get; }

Whether a caret blinks at all.

Methods

FollowSystem

public static void FollowSystem();

Reads the operating system's setting again - after the user changed it, or to undo a value the application set.