Docsv3.31.0
Back to API Reference
Class

InputFilterBase

abstract
Inherits:InputBehavior

Base for input filters — they reject characters as they are typed (digits-only, email chars, …) by subscribing to UniTextEditable.InputFilter. A separate concern from validation (InputValidatorBase), which lets input through and judges the whole value for a visible status.

Remarks

Allows receives the full EditProposal and must judge the POST-state: text replacing a selection is acceptable whenever the resulting value is acceptable, even if the pre-state already contained the typed characters (the replaced ones are going away). Native platforms deliver multi-char strings (macOS NSString, Android CharSequence), so handle codepoints, surrogate pairs, and grapheme clusters. Same extensibility pattern as BaseModifier / ParseRule: stored via [SerializeReference, TypeSelector]; built-in and custom filters appear in the picker.

Derived Types(5)

Types that inherit from InputFilterBase.

C
AlphanumericFilter
Filters alphanumeric input: Unicode letters and ASCII digits [0-9].
C
DecimalFilter
Filters decimal input: digits [0-9], at most one decimal separator (.,,, or the current culture's), plus a single leading minus sign when AllowNegative. The separator is kept as typed — normalization is a commit concern, not the filter's. The negative option also switches the mobile keyboard to a layout that has a minus key — the iOS decimal pad does not.
C
EmailFilter
Filters email-address characters as they are typed: ASCII letters/digits, one @ (not at start),. (not at start, not right after @), and - _ + %. A character filter, not a full RFC 5322 check — pair with a validator for completeness.
C
IntegerFilter
Filters integer input: digits [0-9], plus a single leading minus sign when AllowNegative. The negative option also switches the mobile keyboard to a layout that has a minus key — the iOS number pad does not.
C
NameFilter
Filters name input: Unicode letters, space, hyphen, and apostrophes (incl. U+2019).
public KeyboardType PreferredKeyboardType{ get }

Preferred mobile keyboard type. The input field uses this when no NativeKeyboardBehavior overrides it.

protected override void OnEnable()
protected override void OnDisable()
public abstract bool Allows(in EditProposal proposal)

Whether the proposed edit may be applied, judged on the post-state it produces. Return false to drop it; the editor then discards it without firing TextChanged. Pure deletions never reach this — character filters do not block deleting.

protected static bool DocumentContains(in EditProposal proposal, int targetCodepoint)

Returns true if the document text SURVIVING the proposal (everything outside EditProposal.ReplacedRange) contains targetCodepoint — the post-state membership test, minus the inserted text the filter is already iterating. O(document length) per call: chunked span scans keep the constant small, but a custom filter calling this per inserted character on a multiline document is O(n) per keystroke.

protected static bool AcceptsLeadingSign(in EditProposal proposal, int insertedCharOffset, char sign)

Whether a sign char at insertedCharOffset within EditProposal.Inserted ends up as a single leading sign in the post-state: first inserted char, nothing surviving before it, no other sign surviving. Shared by the numeric filters.

Back to API Reference