OnScreenKeyboardState

interludesoftware.tick

Interlude.Tick

OnScreenKeyboardState Struct

Snapshot of the platform on-screen keyboard's current state, returned by GetOnScreenKeyboardState().

IsActive stays true from the frame the keyboard opens until it dismisses. DidSubmit and DidCancel are one-shot — they report the keyboard's terminal state on the frame it transitions, then go back to false on subsequent frames (the provider's idempotent read protects against double-firing).

public struct OnScreenKeyboardState

Fields

OnScreenKeyboardState.DidCancel Field

True on the frame the user dismissed the keyboard with "Cancel".

public bool DidCancel;

Field Value

System.Boolean

OnScreenKeyboardState.DidSubmit Field

True on the frame the user dismissed the keyboard with the "Done" key.

public bool DidSubmit;

Field Value

System.Boolean

OnScreenKeyboardState.IsActive Field

True while the platform keyboard is visible (or pending).

public bool IsActive;

Field Value

System.Boolean

OnScreenKeyboardState.Text Field

Current edited text. Always non-null; empty before the first edit.

public string Text;

Field Value

System.String