reckfellENGINE

LineEdit

Single-line field with selection, length limits and separate change/submission signals.

On this page
class LineEditReckfellSharpInherits Control

Use LineEdit for a name, search query or other single line; use TextEdit for multiline editing. Read Text as the value and PlaceholderText as a separate hint. Validate input under application rules: MaxLength limits length rather than allowed characters or meaning.

Assigning Text/SetText replaces the string, resets selection, caret and scrolling to the start, and clears previous edit history. It does not emit TextChanged. Populate a form by assigning Text and explicitly refreshing dependent controls; set CaretColumn after Text to position the caret at the end. Do not use C# string.Length as an engine index for strings containing non-BMP characters.

CaretColumn, Select and DeleteText positions count Unicode codepoints, not UTF-16 units or visible composite characters. For example, A😀é has 4 codepoints but string.Length = 5. Use GetNextCompositeCharacterColumn/GetPreviousCompositeCharacterColumn to step across a composite character. CaretColumn is clamped from 0 to text length.

Select(from, to) selects the half-open interval [from, to) without moving the caret. Negative to means end of text. Select(0, 0) deselects; reversed ranges or equal nonzero endpoints retain the previous selection. Check HasSelection before GetSelectionFromColumn/GetSelectionToColumn. Deselect does not change text.

InsertTextAtCaret inserts at the current position and advances the caret, but does not itself replace selection or emit TextChanged. To replace a selection, save its endpoints, deselect, call DeleteText, set CaretColumn to the range start, then insert. DeleteText changes Text immediately but schedules TextChanged for deferred delivery, coalescing multiple such deletions before notification. Clear emits immediately when the field was nonempty.

MaxLength = 0 means unlimited. Positive values limit codepoints. On overflow, the available prefix is accepted and TextChangeRejected receives the discarded tail. Setting MaxLength reapplies Text: it can truncate the string and resets position/selection even for the same limit. TextChangeRejected can occur during programmatic writes that do not emit TextChanged.

Editable = false prevents user editing but does not block programmatic SetText, InsertTextAtCaret, DeleteText or Clear. Secret masks display while retaining original Text; it is not encryption or protection against your code reading the value. TextSubmitted belongs to the ui_text_submit action (usually Enter), not Text assignment. Handle submission separately from changes and validate the value before saving.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

LineEditConstructor
# LineEdit
C#
public LineEdit();

Creates an empty editable field: MaxLength = 0, caret 0, selection enabled, Secret disabled.

Properties36

AlignmentProperty
# Alignment
C#
public HorizontalAlignment Alignment { get; set; }

Horizontal alignment, default Left. Left/Right account for layout direction; Fill justifies through shaping rather than wrapping. Does not set CaretColumn.

BackspaceDeletesCompositeCharacterEnabledProperty
# BackspaceDeletesCompositeCharacterEnabled
C#
public bool BackspaceDeletesCompositeCharacterEnabled { get; set; }

Delete a whole composite character before the caret when CaretMidGrapheme = false; default false removes one codepoint. Also affects DeleteCharAtCaret.

CaretBlinkProperty
# CaretBlink
C#
public bool CaretBlink { get; set; }

Caret blinking, default false. Enabling uses internal frame processing; visibility still depends on editing, focus or CaretForceDisplayed.

CaretBlinkIntervalProperty
# CaretBlinkInterval
C#
public float CaretBlinkInterval { get; set; }

Caret visibility-toggle interval in seconds, default 0.65. Supply a positive finite value; nonpositive values are rejected. Takes effect with CaretBlink = true.

CaretColumnProperty
# CaretColumn
C#
public int CaretColumn { get; set; }

Caret position in Unicode codepoints rather than UTF-16 index; default 0. Setter clamps to 0…text length and adjusts scrolling to show the caret when in the tree.

CaretForceDisplayedProperty
# CaretForceDisplayed
C#
public bool CaretForceDisplayed { get; set; }

Show the caret outside normal editing/focus conditions, default false. Does not start editing or enable Editable. Forced display does not apply to an element belonging to the edited scene.

CaretMidGraphemeProperty
# CaretMidGrapheme
C#
public bool CaretMidGrapheme { get; set; }

Allows caret movement within composite characters, default false. When true, DeleteCharAtCaret removes one codepoint even with composite deletion enabled. Direct CaretColumn assignment does not itself snap indices to grapheme boundaries.

ClearButtonEnabledProperty
# ClearButtonEnabled
C#
public bool ClearButtonEnabled { get; set; }

Built-in clear button, default false. Drawn for a nonempty editable field instead of RightIcon; its space contributes to minimum size even when empty. Clearing changes text rather than submitting it.

ContextMenuEnabledProperty
# ContextMenuEnabled
C#
public bool ContextMenuEnabled { get; set; }

Allows the standard context menu through user input, default true. false does not block GetMenu, direct MenuOption or code-driven text changes.

DeselectOnFocusLossEnabledProperty
# DeselectOnFocusLossEnabled
C#
public bool DeselectOnFocusLossEnabled { get; set; }

Deselect on focus loss/end of editing, default true. Enabling also immediately deselects an already unfocused field. Drag operations have separate selection-retention conditions.

DragAndDropSelectionEnabledProperty
# DragAndDropSelectionEnabled
C#
public bool DragAndDropSelectionEnabled { get; set; }

Allows dragging selected text, default true. Separate from SelectingEnabled; does not block programmatic Select or Text writes.

DrawControlCharsProperty
# DrawControlChars
C#
public bool DrawControlChars { get; set; }

Visualize control characters during shaping, default false. Does not add control characters to Text or change validation rules.

EditableProperty
# Editable
C#
public bool Editable { get; set; }

Allows user editing, default true. false does not block programmatic text operations; disabling it during active editing ends editing.

EmojiMenuEnabledProperty
# EmojiMenuEnabled
C#
public bool EmojiMenuEnabled { get; set; }

Allows the system emoji/symbol picker item in the standard menu, default true. Requires platform support; false does not prohibit emoji input or programmatic insertion.

ExpandToTextLengthProperty
# ExpandToTextLength
C#
public bool ExpandToTextLength { get; set; }

Raises minimum width to shaped-text width plus caret space, default false. Can expand the parent container; leave false for a bounded-width field.

FlatProperty
# Flat
C#
public bool Flat { get; set; }

Skip the normal/read_only background, default false. The separate focus style still draws; style margins and minimum size remain.

IconExpandModeProperty
# IconExpandMode
C#
public LineEdit.ExpandMode IconExpandMode { get; set; }

Sizing for RightIcon and clear icon: OriginalSize uses source dimensions; FitToText uses a square at font height; FitToLineEdit fits field height with a width bound and applies RightIconScale. Default OriginalSize. FitToText does not preserve a nonsquare image’s aspect ratio.

KeepEditingOnTextSubmitProperty
# KeepEditingOnTextSubmit
C#
public bool KeepEditingOnTextSubmit { get; set; }

Continue editing after ui_text_submit, default false. Does not suppress TextSubmitted or validate the value.

LanguageProperty
# Language
C#
public string Language { get; set; }

Shaping language; default empty uses the control locale. Does not translate Text or switch application locale; supply a language code for correct script shaping.

MaxLengthProperty
# MaxLength
C#
public int MaxLength { get; set; }

Maximum Unicode codepoints; 0 means unlimited. Requires a value ≥ 0. Setter reapplies current text, can truncate its tail and resets caret/selection; does not emit TextChanged.

MiddleMousePasteEnabledProperty
# MiddleMousePasteEnabled
C#
public bool MiddleMousePasteEnabled { get; set; }

Allows middle-button primary-selection paste on supported platforms, default true. Separate from regular clipboard paste; false does not block programmatic insertion.

PlaceholderTextProperty
# PlaceholderText
C#
public string PlaceholderText { get; set; }

Separate hint for an empty field, initially empty. Not part of Text or the entered value; display uses its translated form.

RightIconProperty
# RightIcon
C#
public Texture2D RightIcon { get; set; }

Shared right-side Texture2D, default null. Placement mirrors for RTL. Built-in clear button takes priority while visible. Assigned-texture changes refresh minimum size; the resource is not copied.

RightIconScaleProperty
# RightIconScale
C#
public float RightIconScale { get; set; }

Icon-size multiplier only for IconExpandMode = FitToLineEdit, default 1. Other modes ignore it. Setter does not clamp the range: use a positive finite value, typically 0.1–1.

SecretProperty
# Secret
C#
public bool Secret { get; set; }

Masks display, default false. Text and GetSelectedText retain original characters; this is not encryption or secure password storage.

SecretCharacterProperty
# SecretCharacter
C#
public string SecretCharacter { get; set; }

Mask character, default •. Supply one Unicode codepoint: longer strings warn and are truncated. An empty value draws the default • without clearing Text.

SelectAllOnFocusProperty
# SelectAllOnFocus
C#
public bool SelectAllOnFocus { get; set; }

Select all text when editing starts, default false. With the left mouse button held, selection waits until release. Does not override SelectingEnabled = false.

SelectingEnabledProperty
# SelectingEnabled
C#
public bool SelectingEnabled { get; set; }

Allows selection, default true. Disabling clears selection; Select and SelectAll do nothing while false.

ShortcutKeysEnabledProperty
# ShortcutKeysEnabled
C#
public bool ShortcutKeysEnabled { get; set; }

Allows built-in editing shortcuts, default true. Does not disable normal typing and every navigation action, direct MenuOption or programmatic Text writes.

StructuredTextBidiOverrideProperty
# StructuredTextBidiOverride
C#
public TextServer.StructuredTextParser StructuredTextBidiOverride { get; set; }

BiDi parsing rule for structured text, default Default. Uri/File/Email/List preserve meaningful parts of mixed-direction strings; Custom uses the Control callback. Does not change original Text.

StructuredTextBidiOverrideOptionsProperty
# StructuredTextBidiOverrideOptions
C#
public Reckfell.Collections.Array StructuredTextBidiOverrideOptions { get; set; }

Shared Array of BiDi-parser options. Getter and setter share the container; mutating an alias does not trigger shaping. Copy before editing and assign through the setter to refresh.

TextProperty
# Text
C#
public string Text { get; set; }

Raw field value, initially empty. Setter replaces text subject to MaxLength, clears selection/previous history and resets caret/scroll to the start. Does not emit TextChanged; overflow can emit TextChangeRejected.

TextDirectionProperty
# TextDirection
C#
public Control.TextDirection TextDirection { get; set; }

Text shaping direction, default Auto. Inherited uses layout direction; Ltr/Rtl explicitly set direction. Does not reverse stored text or replace LayoutDirection.

VirtualKeyboardEnabledProperty
# VirtualKeyboardEnabled
C#
public bool VirtualKeyboardEnabled { get; set; }

Allows virtual-keyboard requests on supported platforms, default true. Does not create an on-screen keyboard or disable hardware input when false.

VirtualKeyboardShowOnFocusProperty
# VirtualKeyboardShowOnFocus
C#
public bool VirtualKeyboardShowOnFocus { get; set; }

Request the virtual keyboard on focus, default true. Requires VirtualKeyboardEnabled and platform support. Explicit Edit can request it even when false.

VirtualKeyboardTypeProperty
# VirtualKeyboardType
C#
public LineEdit.VirtualKeyboardTypeEnum VirtualKeyboardType { get; set; }

Keyboard-type hint to the platform, default Default. Number/EmailAddress and other values do not filter Text or replace input validation.

Methods98

ApplyImevoid
# ApplyIme
C#
public void ApplyIme();

Commits current composition through InsertTextAtCaret and closes the IME window. Respects MaxLength but does not itself emit TextChanged or replace selection as an input operation would. Without composition, only closes the IME window where supported.

CancelImevoid
# CancelIme
C#
public void CancelIme();

Discards unfinished IME composition and closes the IME window without inserting it into Text. Does not remove already committed text and is not Undo.

Clearvoid
# Clear
C#
public void Clear();

Clears text, selection and history, resets caret/scroll. Emits TextChanged immediately only when previous text was nonempty. Also works with Editable = false.

DeleteCharAtCaretvoid
# DeleteCharAtCaret
C#
public void DeleteCharAtCaret();

Deletes before the caret and emits TextChanged immediately. Defaults to one codepoint; with BackspaceDeletesCompositeCharacterEnabled = true and CaretMidGrapheme = false deletes the previous composite character. Does nothing at the start or in an empty field. This is not selection deletion.

DeleteTextvoid
# DeleteText
C#
public void DeleteText(int fromColumn, int toColumn);

Deletes [fromColumn, toColumn) in codepoints; requires 0 ≤ fromColumn ≤ toColumn ≤ length. Text/caret change immediately; TextChanged is scheduled deferred in the tree, coalescing deletions before delivery. Does not automatically clear selection; manage it separately.

Parameters
NameTypeDefault
fromColumnint—
toColumnint—
fromColumn

Half-open range start in Unicode codepoints; DeleteText requires a valid index.

toColumn

Exclusive end in codepoints. Only Select accepts a negative value to mean end of text.

Deselectvoid
# Deselect
C#
public void Deselect();

Clears selection and resets its bounds without changing text or caret position.

Edit2 overloads
# Edit · 1/2
C#
public void Edit();

Starts editing in the tree, requesting focus first if needed. Requires Editable. hideFocus hides the requested focus indication rather than input itself. With existing focus, direct Edit changes state without EditingToggled; acquiring focus can emit through FocusEnter. Explicit Edit requests the virtual keyboard independently of VirtualKeyboardShowOnFocus, subject to VirtualKeyboardEnabled and platform support.

# Edit · 2/2
C#
public void Edit(bool hideFocus = false);

Starts editing in the tree, requesting focus first if needed. Requires Editable. hideFocus hides the requested focus indication rather than input itself. With existing focus, direct Edit changes state without EditingToggled; acquiring focus can emit through FocusEnter. Explicit Edit requests the virtual keyboard independently of VirtualKeyboardShowOnFocus, subject to VirtualKeyboardEnabled and platform support.

Parameters
NameTypeDefault
hideFocusboolfalse
hideFocus

Hide focus indication when acquiring focus through Edit.

GetCaretBlinkIntervalfloat
# GetCaretBlinkInterval
C#
public float GetCaretBlinkInterval();

Caret visibility-toggle interval in seconds, default 0.65. Supply a positive finite value; nonpositive values are rejected. Takes effect with CaretBlink = true.

Returns float

Visibility-toggle interval in seconds.

GetCaretColumnint
# GetCaretColumn
C#
public int GetCaretColumn();

Caret position in Unicode codepoints rather than UTF-16 index; default 0. Setter clamps to 0…text length and adjusts scrolling to show the caret when in the tree.

Returns int

Current codepoint caret column.

GetDrawControlCharsbool
# GetDrawControlChars
C#
public bool GetDrawControlChars();

Visualize control characters during shaping, default false. Does not add control characters to Text or change validation rules.

Returns bool

Control-character visualization flag.

GetHorizontalAlignmentHorizontalAlignment
# GetHorizontalAlignment
C#
public HorizontalAlignment GetHorizontalAlignment();

Horizontal alignment, default Left. Left/Right account for layout direction; Fill justifies through shaping rather than wrapping. Does not set CaretColumn.

Returns HorizontalAlignment

Current HorizontalAlignment.

GetIconExpandModeLineEdit.ExpandMode
# GetIconExpandMode
C#
public LineEdit.ExpandMode GetIconExpandMode();

Sizing for RightIcon and clear icon: OriginalSize uses source dimensions; FitToText uses a square at font height; FitToLineEdit fits field height with a width bound and applies RightIconScale. Default OriginalSize. FitToText does not preserve a nonsquare image’s aspect ratio.

Returns LineEdit.ExpandMode

Current LineEdit.ExpandMode.

GetLanguagestring
# GetLanguage
C#
public string GetLanguage();

Shaping language; default empty uses the control locale. Does not translate Text or switch application locale; supply a language code for correct script shaping.

Returns string

Shaping language, or empty for the control locale.

GetMaxLengthint
# GetMaxLength
C#
public int GetMaxLength();

Maximum Unicode codepoints; 0 means unlimited. Requires a value ≥ 0. Setter reapplies current text, can truncate its tail and resets caret/selection; does not emit TextChanged.

Returns int

Codepoint limit; 0 means unlimited.

GetMenuPopupMenu
# GetMenu
C#
public PopupMenu GetMenu();

Lazily creates and returns the internal PopupMenu owned by LineEdit. Do not free or remove it. Works with ContextMenuEnabled = false and does not open it. Built-in items are refreshed before display; preserve their IDs and avoid replacing built-in command handling.

Returns PopupMenu

Shared internal PopupMenu owned by the field.

GetNextCompositeCharacterColumnint
# GetNextCompositeCharacterColumn
C#
public int GetNextCompositeCharacterColumn(int column);

Returns the position after a composite character according to shaping. Requires a codepoint column in 0…length; returns the same position at the end.

Parameters
NameTypeDefault
columnint—
column

Current codepoint position: 0…Text length, not a UTF-16 index.

Returns int

Next composite-character boundary in codepoints; current position at the end.

GetPlaceholderstring
# GetPlaceholder
C#
public string GetPlaceholder();

Separate hint for an empty field, initially empty. Not part of Text or the entered value; display uses its translated form.

Returns string

Original placeholder string rather than the entered value.

GetPreviousCompositeCharacterColumnint
# GetPreviousCompositeCharacterColumn
C#
public int GetPreviousCompositeCharacterColumn(int column);

Returns the position before a composite character according to shaping. Requires a codepoint column in 0…length; returns 0 at the start.

Parameters
NameTypeDefault
columnint—
column

Current codepoint position: 0…Text length, not a UTF-16 index.

Returns int

Previous composite-character boundary in codepoints; 0 at the start.

GetRightIconTexture2D
# GetRightIcon
C#
public Texture2D GetRightIcon();

Shared right-side Texture2D, default null. Placement mirrors for RTL. Built-in clear button takes priority while visible. Assigned-texture changes refresh minimum size; the resource is not copied.

Returns Texture2D

Shared Texture2D, or null.

GetRightIconScalefloat
# GetRightIconScale
C#
public float GetRightIconScale();

Icon-size multiplier only for IconExpandMode = FitToLineEdit, default 1. Other modes ignore it. Setter does not clamp the range: use a positive finite value, typically 0.1–1.

Returns float

Stored FitToLineEdit sizing multiplier.

GetScrollOffsetfloat
# GetScrollOffset
C#
public float GetScrollOffset();

Returns horizontal text drawing translation in local pixels, normally ≤ 0. Not a character index or positive ScrollBar position; changes while keeping the caret visible.

Returns float

Text drawing translation in local pixels.

GetSecretCharacterstring
# GetSecretCharacter
C#
public string GetSecretCharacter();

Mask character, default •. Supply one Unicode codepoint: longer strings warn and are truncated. An empty value draws the default • without clearing Text.

Returns string

Stored mask character, or an empty string.

GetSelectedTextstring
# GetSelectedText
C#
public string GetSelectedText();

Returns selected original Text, including in Secret mode; returns an empty string without selection.

Returns string

Selected original text, or an empty string.

GetSelectionFromColumnint
# GetSelectionFromColumn
C#
public int GetSelectionFromColumn();

Returns selection start in codepoints. Check HasSelection first: without selection the method reports an error and returns -1.

Returns int

Inclusive start column; -1 with an error when no selection exists.

GetSelectionToColumnint
# GetSelectionToColumn
C#
public int GetSelectionToColumn();

Returns the exclusive selection end in codepoints. Check HasSelection first: without selection it reports an error and returns -1.

Returns int

Exclusive end column; -1 with an error when no selection exists.

GetStructuredTextBidiOverrideTextServer.StructuredTextParser
# GetStructuredTextBidiOverride
C#
public TextServer.StructuredTextParser GetStructuredTextBidiOverride();

BiDi parsing rule for structured text, default Default. Uri/File/Email/List preserve meaningful parts of mixed-direction strings; Custom uses the Control callback. Does not change original Text.

Returns TextServer.StructuredTextParser

Selected TextServer.StructuredTextParser.

GetStructuredTextBidiOverrideOptionsReckfell.Collections.Array
# GetStructuredTextBidiOverrideOptions
C#
public Reckfell.Collections.Array GetStructuredTextBidiOverrideOptions();

Shared Array of BiDi-parser options. Getter and setter share the container; mutating an alias does not trigger shaping. Copy before editing and assign through the setter to refresh.

Returns Reckfell.Collections.Array

Options Array sharing its contents.

GetTextstring
# GetText
C#
public string GetText();

Raw field value, initially empty. Setter replaces text subject to MaxLength, clears selection/previous history and resets caret/scroll to the start. Does not emit TextChanged; overflow can emit TextChangeRejected.

Returns string

Original field text, without masking or placeholder.

GetTextDirectionControl.TextDirection
# GetTextDirection
C#
public Control.TextDirection GetTextDirection();

Text shaping direction, default Auto. Inherited uses layout direction; Ltr/Rtl explicitly set direction. Does not reverse stored text or replace LayoutDirection.

Returns Control.TextDirection

Selected Control.TextDirection.

GetVirtualKeyboardShowOnFocusbool
# GetVirtualKeyboardShowOnFocus
C#
public bool GetVirtualKeyboardShowOnFocus();

Request the virtual keyboard on focus, default true. Requires VirtualKeyboardEnabled and platform support. Explicit Edit can request it even when false.

Returns bool

Request-keyboard-on-focus flag.

GetVirtualKeyboardTypeLineEdit.VirtualKeyboardTypeEnum
# GetVirtualKeyboardType
C#
public LineEdit.VirtualKeyboardTypeEnum GetVirtualKeyboardType();

Keyboard-type hint to the platform, default Default. Number/EmailAddress and other values do not filter Text or replace input validation.

Returns LineEdit.VirtualKeyboardTypeEnum

LineEdit.VirtualKeyboardTypeEnum hint.

HasImeTextbool
# HasImeText
C#
public bool HasImeText();

Whether an unfinished IME composition exists. Displayed separately from committed Text; false does not mean the platform lacks IME support.

Returns bool

true for unfinished composition.

HasRedobool
# HasRedo
C#
public bool HasRedo();

Whether a next state is available after undo. A new edit can discard that branch; Editable = false separately blocks executing Redo.

Returns bool

true when a next history state exists.

HasSelectionbool
# HasSelection
C#
public bool HasSelection();

Checks for active selection. Use before reading selection endpoints.

Returns bool

true when selection is active.

HasUndobool
# HasUndo
C#
public bool HasUndo();

Whether a previous history state is available. Does not mean undo is permitted when Editable = false. Clear rebuilds history but the previous value can remain undoable; do not treat clearing as secure erasure.

Returns bool

true when a previous history state exists.

InsertTextAtCaretvoid
# InsertTextAtCaret
C#
public void InsertTextAtCaret(string text);

Inserts text at the caret and advances past the accepted portion. Respects MaxLength and emits TextChangeRejected for the tail. Does not itself remove selection, check Editable or emit TextChanged.

Parameters
NameTypeDefault
textstring—
text

Inserts text at the caret and advances past the accepted portion. Respects MaxLength and emits TextChangeRejected for the tail. Does not itself remove selection, check Editable or emit TextChanged.

IsBackspaceDeletesCompositeCharacterEnabledbool
# IsBackspaceDeletesCompositeCharacterEnabled
C#
public bool IsBackspaceDeletesCompositeCharacterEnabled();

Delete a whole composite character before the caret when CaretMidGrapheme = false; default false removes one codepoint. Also affects DeleteCharAtCaret.

Returns bool

Composite-deletion flag used when CaretMidGrapheme = false.

IsCaretBlinkEnabledbool
# IsCaretBlinkEnabled
C#
public bool IsCaretBlinkEnabled();

Caret blinking, default false. Enabling uses internal frame processing; visibility still depends on editing, focus or CaretForceDisplayed.

Returns bool

Stored CaretBlink flag.

IsCaretForceDisplayedbool
# IsCaretForceDisplayed
C#
public bool IsCaretForceDisplayed();

Show the caret outside normal editing/focus conditions, default false. Does not start editing or enable Editable. Forced display does not apply to an element belonging to the edited scene.

Returns bool

Stored CaretForceDisplayed flag.

IsCaretMidGraphemeEnabledbool
# IsCaretMidGraphemeEnabled
C#
public bool IsCaretMidGraphemeEnabled();

Allows caret movement within composite characters, default false. When true, DeleteCharAtCaret removes one codepoint even with composite deletion enabled. Direct CaretColumn assignment does not itself snap indices to grapheme boundaries.

Returns bool

Whether movement within composite characters is allowed.

IsClearButtonEnabledbool
# IsClearButtonEnabled
C#
public bool IsClearButtonEnabled();

Built-in clear button, default false. Drawn for a nonempty editable field instead of RightIcon; its space contributes to minimum size even when empty. Clearing changes text rather than submitting it.

Returns bool

Stored ClearButtonEnabled flag.

IsContextMenuEnabledbool
# IsContextMenuEnabled
C#
public bool IsContextMenuEnabled();

Allows the standard context menu through user input, default true. false does not block GetMenu, direct MenuOption or code-driven text changes.

Returns bool

Stored ContextMenuEnabled flag.

IsDeselectOnFocusLossEnabledbool
# IsDeselectOnFocusLossEnabled
C#
public bool IsDeselectOnFocusLossEnabled();

Deselect on focus loss/end of editing, default true. Enabling also immediately deselects an already unfocused field. Drag operations have separate selection-retention conditions.

Returns bool

Stored DeselectOnFocusLossEnabled flag.

IsDragAndDropSelectionEnabledbool
# IsDragAndDropSelectionEnabled
C#
public bool IsDragAndDropSelectionEnabled();

Allows dragging selected text, default true. Separate from SelectingEnabled; does not block programmatic Select or Text writes.

Returns bool

Stored DragAndDropSelectionEnabled flag.

IsEditablebool
# IsEditable
C#
public bool IsEditable();

Allows user editing, default true. false does not block programmatic text operations; disabling it during active editing ends editing.

Returns bool

User-editing permission flag.

IsEditingbool
# IsEditing
C#
public bool IsEditing();

Returns editing state, separate from Editable and HasFocus. A field can retain focus after Unedit while no longer editing.

Returns bool

Current editing state.

IsEditingKeptOnTextSubmitbool
# IsEditingKeptOnTextSubmit
C#
public bool IsEditingKeptOnTextSubmit();

Continue editing after ui_text_submit, default false. Does not suppress TextSubmitted or validate the value.

Returns bool

Whether editing continues after submission.

IsEmojiMenuEnabledbool
# IsEmojiMenuEnabled
C#
public bool IsEmojiMenuEnabled();

Allows the system emoji/symbol picker item in the standard menu, default true. Requires platform support; false does not prohibit emoji input or programmatic insertion.

Returns bool

Stored EmojiMenuEnabled flag.

IsExpandToTextLengthEnabledbool
# IsExpandToTextLengthEnabled
C#
public bool IsExpandToTextLengthEnabled();

Raises minimum width to shaped-text width plus caret space, default false. Can expand the parent container; leave false for a bounded-width field.

Returns bool

Stored ExpandToTextLength flag.

IsFlatbool
# IsFlat
C#
public bool IsFlat();

Skip the normal/read_only background, default false. The separate focus style still draws; style margins and minimum size remain.

Returns bool

Stored Flat flag.

IsMenuVisiblebool
# IsMenuVisible
C#
public bool IsMenuVisible();

Returns visibility of the created context menu; false before creation. Does not itself create the menu.

Returns bool

true when the internal menu exists and is visible.

IsMiddleMousePasteEnabledbool
# IsMiddleMousePasteEnabled
C#
public bool IsMiddleMousePasteEnabled();

Allows middle-button primary-selection paste on supported platforms, default true. Separate from regular clipboard paste; false does not block programmatic insertion.

Returns bool

Stored MiddleMousePasteEnabled flag.

IsSecretbool
# IsSecret
C#
public bool IsSecret();

Masks display, default false. Text and GetSelectedText retain original characters; this is not encryption or secure password storage.

Returns bool

Display-masking flag.

IsSelectAllOnFocusbool
# IsSelectAllOnFocus
C#
public bool IsSelectAllOnFocus();

Select all text when editing starts, default false. With the left mouse button held, selection waits until release. Does not override SelectingEnabled = false.

Returns bool

Stored SelectAllOnFocus flag.

IsSelectingEnabledbool
# IsSelectingEnabled
C#
public bool IsSelectingEnabled();

Allows selection, default true. Disabling clears selection; Select and SelectAll do nothing while false.

Returns bool

Selection permission flag.

IsShortcutKeysEnabledbool
# IsShortcutKeysEnabled
C#
public bool IsShortcutKeysEnabled();

Allows built-in editing shortcuts, default true. Does not disable normal typing and every navigation action, direct MenuOption or programmatic Text writes.

Returns bool

Stored ShortcutKeysEnabled flag.

IsVirtualKeyboardEnabledbool
# IsVirtualKeyboardEnabled
C#
public bool IsVirtualKeyboardEnabled();

Allows virtual-keyboard requests on supported platforms, default true. Does not create an on-screen keyboard or disable hardware input when false.

Returns bool

Stored VirtualKeyboardEnabled flag.

MenuOptionvoid
# MenuOption
C#
public void MenuOption(int option);

Executes a command by numeric LineEdit.MenuItems value rather than PopupMenu item index. ContextMenuEnabled does not block this call. Clear/Cut/Paste/Undo/Redo check Editable; SelectAll checks SelectingEnabled. Clipboard/emoji commands can access the OS. Handle custom items yourself rather than passing arbitrary values to MenuOption.

Parameters
NameTypeDefault
optionint—
option

Numeric built-in LineEdit.MenuItems value rather than a menu index.

Selectvoid
# Select
C#
public void Select(int from = 0, int to = -1);

Selects [from, to) in codepoints without moving the caret. from clamps to 0…length; negative or excessive to means end. (0, 0) deselects; normalized from ≥ to retains the previous selection. Does nothing when SelectingEnabled = false.

Parameters
NameTypeDefault
fromint0
toint-1
from

Half-open range start in Unicode codepoints; DeleteText requires a valid index.

to

Exclusive end in codepoints. Only Select accepts a negative value to mean end of text.

SelectAllvoid
# SelectAll
C#
public void SelectAll();

Selects all nonempty text if SelectingEnabled is enabled. Does not move a nonempty field’s caret; positions it at 0 in an empty field.

SetBackspaceDeletesCompositeCharacterEnabledvoid
# SetBackspaceDeletesCompositeCharacterEnabled
C#
public void SetBackspaceDeletesCompositeCharacterEnabled(bool enable);

Delete a whole composite character before the caret when CaretMidGrapheme = false; default false removes one codepoint. Also affects DeleteCharAtCaret.

Parameters
NameTypeDefault
enablebool—
enable

Delete a whole composite character before the caret when CaretMidGrapheme = false; default false removes one codepoint. Also affects DeleteCharAtCaret.

SetCaretBlinkEnabledvoid
# SetCaretBlinkEnabled
C#
public void SetCaretBlinkEnabled(bool enabled);

Caret blinking, default false. Enabling uses internal frame processing; visibility still depends on editing, focus or CaretForceDisplayed.

Parameters
NameTypeDefault
enabledbool—
enabled

Caret blinking, default false. Enabling uses internal frame processing; visibility still depends on editing, focus or CaretForceDisplayed.

SetCaretBlinkIntervalvoid
# SetCaretBlinkInterval
C#
public void SetCaretBlinkInterval(float interval);

Caret visibility-toggle interval in seconds, default 0.65. Supply a positive finite value; nonpositive values are rejected. Takes effect with CaretBlink = true.

Parameters
NameTypeDefault
intervalfloat—
interval

Caret visibility-toggle interval in seconds, default 0.65. Supply a positive finite value; nonpositive values are rejected. Takes effect with CaretBlink = true.

SetCaretColumnvoid
# SetCaretColumn
C#
public void SetCaretColumn(int position);

Caret position in Unicode codepoints rather than UTF-16 index; default 0. Setter clamps to 0…text length and adjusts scrolling to show the caret when in the tree.

Parameters
NameTypeDefault
positionint—
position

Caret position in Unicode codepoints rather than UTF-16 index; default 0. Setter clamps to 0…text length and adjusts scrolling to show the caret when in the tree.

SetCaretForceDisplayedvoid
# SetCaretForceDisplayed
C#
public void SetCaretForceDisplayed(bool enabled);

Show the caret outside normal editing/focus conditions, default false. Does not start editing or enable Editable. Forced display does not apply to an element belonging to the edited scene.

Parameters
NameTypeDefault
enabledbool—
enabled

Show the caret outside normal editing/focus conditions, default false. Does not start editing or enable Editable. Forced display does not apply to an element belonging to the edited scene.

SetCaretMidGraphemeEnabledvoid
# SetCaretMidGraphemeEnabled
C#
public void SetCaretMidGraphemeEnabled(bool enabled);

Allows caret movement within composite characters, default false. When true, DeleteCharAtCaret removes one codepoint even with composite deletion enabled. Direct CaretColumn assignment does not itself snap indices to grapheme boundaries.

Parameters
NameTypeDefault
enabledbool—
enabled

Allows caret movement within composite characters, default false. When true, DeleteCharAtCaret removes one codepoint even with composite deletion enabled. Direct CaretColumn assignment does not itself snap indices to grapheme boundaries.

SetClearButtonEnabledvoid
# SetClearButtonEnabled
C#
public void SetClearButtonEnabled(bool enable);

Built-in clear button, default false. Drawn for a nonempty editable field instead of RightIcon; its space contributes to minimum size even when empty. Clearing changes text rather than submitting it.

Parameters
NameTypeDefault
enablebool—
enable

Built-in clear button, default false. Drawn for a nonempty editable field instead of RightIcon; its space contributes to minimum size even when empty. Clearing changes text rather than submitting it.

SetContextMenuEnabledvoid
# SetContextMenuEnabled
C#
public void SetContextMenuEnabled(bool enable);

Allows the standard context menu through user input, default true. false does not block GetMenu, direct MenuOption or code-driven text changes.

Parameters
NameTypeDefault
enablebool—
enable

Allows the standard context menu through user input, default true. false does not block GetMenu, direct MenuOption or code-driven text changes.

SetDeselectOnFocusLossEnabledvoid
# SetDeselectOnFocusLossEnabled
C#
public void SetDeselectOnFocusLossEnabled(bool enable);

Deselect on focus loss/end of editing, default true. Enabling also immediately deselects an already unfocused field. Drag operations have separate selection-retention conditions.

Parameters
NameTypeDefault
enablebool—
enable

Deselect on focus loss/end of editing, default true. Enabling also immediately deselects an already unfocused field. Drag operations have separate selection-retention conditions.

SetDragAndDropSelectionEnabledvoid
# SetDragAndDropSelectionEnabled
C#
public void SetDragAndDropSelectionEnabled(bool enable);

Allows dragging selected text, default true. Separate from SelectingEnabled; does not block programmatic Select or Text writes.

Parameters
NameTypeDefault
enablebool—
enable

Allows dragging selected text, default true. Separate from SelectingEnabled; does not block programmatic Select or Text writes.

SetDrawControlCharsvoid
# SetDrawControlChars
C#
public void SetDrawControlChars(bool enable);

Visualize control characters during shaping, default false. Does not add control characters to Text or change validation rules.

Parameters
NameTypeDefault
enablebool—
enable

Visualize control characters during shaping, default false. Does not add control characters to Text or change validation rules.

SetEditablevoid
# SetEditable
C#
public void SetEditable(bool enabled);

Allows user editing, default true. false does not block programmatic text operations; disabling it during active editing ends editing.

Parameters
NameTypeDefault
enabledbool—
enabled

Allows user editing, default true. false does not block programmatic text operations; disabling it during active editing ends editing.

SetEmojiMenuEnabledvoid
# SetEmojiMenuEnabled
C#
public void SetEmojiMenuEnabled(bool enable);

Allows the system emoji/symbol picker item in the standard menu, default true. Requires platform support; false does not prohibit emoji input or programmatic insertion.

Parameters
NameTypeDefault
enablebool—
enable

Allows the system emoji/symbol picker item in the standard menu, default true. Requires platform support; false does not prohibit emoji input or programmatic insertion.

SetExpandToTextLengthEnabledvoid
# SetExpandToTextLengthEnabled
C#
public void SetExpandToTextLengthEnabled(bool enabled);

Raises minimum width to shaped-text width plus caret space, default false. Can expand the parent container; leave false for a bounded-width field.

Parameters
NameTypeDefault
enabledbool—
enabled

Raises minimum width to shaped-text width plus caret space, default false. Can expand the parent container; leave false for a bounded-width field.

SetFlatvoid
# SetFlat
C#
public void SetFlat(bool enabled);

Skip the normal/read_only background, default false. The separate focus style still draws; style margins and minimum size remain.

Parameters
NameTypeDefault
enabledbool—
enabled

Skip the normal/read_only background, default false. The separate focus style still draws; style margins and minimum size remain.

SetHorizontalAlignmentvoid
# SetHorizontalAlignment
C#
public void SetHorizontalAlignment(HorizontalAlignment alignment);

Horizontal alignment, default Left. Left/Right account for layout direction; Fill justifies through shaping rather than wrapping. Does not set CaretColumn.

Parameters
NameTypeDefault
alignmentHorizontalAlignment—
alignment

Horizontal alignment, default Left. Left/Right account for layout direction; Fill justifies through shaping rather than wrapping. Does not set CaretColumn.

SetIconExpandModevoid
# SetIconExpandMode
C#
public void SetIconExpandMode(LineEdit.ExpandMode mode);

Sizing for RightIcon and clear icon: OriginalSize uses source dimensions; FitToText uses a square at font height; FitToLineEdit fits field height with a width bound and applies RightIconScale. Default OriginalSize. FitToText does not preserve a nonsquare image’s aspect ratio.

Parameters
NameTypeDefault
modeLineEdit.ExpandMode—
mode

Sizing for RightIcon and clear icon: OriginalSize uses source dimensions; FitToText uses a square at font height; FitToLineEdit fits field height with a width bound and applies RightIconScale. Default OriginalSize. FitToText does not preserve a nonsquare image’s aspect ratio.

SetKeepEditingOnTextSubmitvoid
# SetKeepEditingOnTextSubmit
C#
public void SetKeepEditingOnTextSubmit(bool enable);

Continue editing after ui_text_submit, default false. Does not suppress TextSubmitted or validate the value.

Parameters
NameTypeDefault
enablebool—
enable

Continue editing after ui_text_submit, default false. Does not suppress TextSubmitted or validate the value.

SetLanguagevoid
# SetLanguage
C#
public void SetLanguage(string language);

Shaping language; default empty uses the control locale. Does not translate Text or switch application locale; supply a language code for correct script shaping.

Parameters
NameTypeDefault
languagestring—
language

Shaping language; default empty uses the control locale. Does not translate Text or switch application locale; supply a language code for correct script shaping.

SetMaxLengthvoid
# SetMaxLength
C#
public void SetMaxLength(int chars);

Maximum Unicode codepoints; 0 means unlimited. Requires a value ≥ 0. Setter reapplies current text, can truncate its tail and resets caret/selection; does not emit TextChanged.

Parameters
NameTypeDefault
charsint—
chars

Maximum Unicode codepoints; 0 means unlimited. Requires a value ≥ 0. Setter reapplies current text, can truncate its tail and resets caret/selection; does not emit TextChanged.

SetMiddleMousePasteEnabledvoid
# SetMiddleMousePasteEnabled
C#
public void SetMiddleMousePasteEnabled(bool enable);

Allows middle-button primary-selection paste on supported platforms, default true. Separate from regular clipboard paste; false does not block programmatic insertion.

Parameters
NameTypeDefault
enablebool—
enable

Allows middle-button primary-selection paste on supported platforms, default true. Separate from regular clipboard paste; false does not block programmatic insertion.

SetPlaceholdervoid
# SetPlaceholder
C#
public void SetPlaceholder(string text);

Separate hint for an empty field, initially empty. Not part of Text or the entered value; display uses its translated form.

Parameters
NameTypeDefault
textstring—
text

Separate hint for an empty field, initially empty. Not part of Text or the entered value; display uses its translated form.

SetRightIconvoid
# SetRightIcon
C#
public void SetRightIcon(Texture2D icon);

Shared right-side Texture2D, default null. Placement mirrors for RTL. Built-in clear button takes priority while visible. Assigned-texture changes refresh minimum size; the resource is not copied.

Parameters
NameTypeDefault
iconTexture2D—
icon

Shared right-side Texture2D, default null. Placement mirrors for RTL. Built-in clear button takes priority while visible. Assigned-texture changes refresh minimum size; the resource is not copied.

SetRightIconScalevoid
# SetRightIconScale
C#
public void SetRightIconScale(float scale);

Icon-size multiplier only for IconExpandMode = FitToLineEdit, default 1. Other modes ignore it. Setter does not clamp the range: use a positive finite value, typically 0.1–1.

Parameters
NameTypeDefault
scalefloat—
scale

Icon-size multiplier only for IconExpandMode = FitToLineEdit, default 1. Other modes ignore it. Setter does not clamp the range: use a positive finite value, typically 0.1–1.

SetSecretvoid
# SetSecret
C#
public void SetSecret(bool enabled);

Masks display, default false. Text and GetSelectedText retain original characters; this is not encryption or secure password storage.

Parameters
NameTypeDefault
enabledbool—
enabled

Masks display, default false. Text and GetSelectedText retain original characters; this is not encryption or secure password storage.

SetSecretCharactervoid
# SetSecretCharacter
C#
public void SetSecretCharacter(string character);

Mask character, default •. Supply one Unicode codepoint: longer strings warn and are truncated. An empty value draws the default • without clearing Text.

Parameters
NameTypeDefault
characterstring—
character

Mask character, default •. Supply one Unicode codepoint: longer strings warn and are truncated. An empty value draws the default • without clearing Text.

SetSelectAllOnFocusvoid
# SetSelectAllOnFocus
C#
public void SetSelectAllOnFocus(bool enabled);

Select all text when editing starts, default false. With the left mouse button held, selection waits until release. Does not override SelectingEnabled = false.

Parameters
NameTypeDefault
enabledbool—
enabled

Select all text when editing starts, default false. With the left mouse button held, selection waits until release. Does not override SelectingEnabled = false.

SetSelectingEnabledvoid
# SetSelectingEnabled
C#
public void SetSelectingEnabled(bool enable);

Allows selection, default true. Disabling clears selection; Select and SelectAll do nothing while false.

Parameters
NameTypeDefault
enablebool—
enable

Allows selection, default true. Disabling clears selection; Select and SelectAll do nothing while false.

SetShortcutKeysEnabledvoid
# SetShortcutKeysEnabled
C#
public void SetShortcutKeysEnabled(bool enable);

Allows built-in editing shortcuts, default true. Does not disable normal typing and every navigation action, direct MenuOption or programmatic Text writes.

Parameters
NameTypeDefault
enablebool—
enable

Allows built-in editing shortcuts, default true. Does not disable normal typing and every navigation action, direct MenuOption or programmatic Text writes.

SetStructuredTextBidiOverridevoid
# SetStructuredTextBidiOverride
C#
public void SetStructuredTextBidiOverride(TextServer.StructuredTextParser parser);

BiDi parsing rule for structured text, default Default. Uri/File/Email/List preserve meaningful parts of mixed-direction strings; Custom uses the Control callback. Does not change original Text.

Parameters
NameTypeDefault
parserTextServer.StructuredTextParser—
parser

BiDi parsing rule for structured text, default Default. Uri/File/Email/List preserve meaningful parts of mixed-direction strings; Custom uses the Control callback. Does not change original Text.

SetStructuredTextBidiOverrideOptionsvoid
# SetStructuredTextBidiOverrideOptions
C#
public void SetStructuredTextBidiOverrideOptions(Reckfell.Collections.Array args);

Shared Array of BiDi-parser options. Getter and setter share the container; mutating an alias does not trigger shaping. Copy before editing and assign through the setter to refresh.

Parameters
NameTypeDefault
argsReckfell.Collections.Array—
args

Shared Array of BiDi-parser options. Getter and setter share the container; mutating an alias does not trigger shaping. Copy before editing and assign through the setter to refresh.

SetTextvoid
# SetText
C#
public void SetText(string text);

Raw field value, initially empty. Setter replaces text subject to MaxLength, clears selection/previous history and resets caret/scroll to the start. Does not emit TextChanged; overflow can emit TextChangeRejected.

Parameters
NameTypeDefault
textstring—
text

Raw field value, initially empty. Setter replaces text subject to MaxLength, clears selection/previous history and resets caret/scroll to the start. Does not emit TextChanged; overflow can emit TextChangeRejected.

SetTextDirectionvoid
# SetTextDirection
C#
public void SetTextDirection(Control.TextDirection direction);

Text shaping direction, default Auto. Inherited uses layout direction; Ltr/Rtl explicitly set direction. Does not reverse stored text or replace LayoutDirection.

Parameters
NameTypeDefault
directionControl.TextDirection—
direction

Text shaping direction, default Auto. Inherited uses layout direction; Ltr/Rtl explicitly set direction. Does not reverse stored text or replace LayoutDirection.

SetVirtualKeyboardEnabledvoid
# SetVirtualKeyboardEnabled
C#
public void SetVirtualKeyboardEnabled(bool enable);

Allows virtual-keyboard requests on supported platforms, default true. Does not create an on-screen keyboard or disable hardware input when false.

Parameters
NameTypeDefault
enablebool—
enable

Allows virtual-keyboard requests on supported platforms, default true. Does not create an on-screen keyboard or disable hardware input when false.

SetVirtualKeyboardShowOnFocusvoid
# SetVirtualKeyboardShowOnFocus
C#
public void SetVirtualKeyboardShowOnFocus(bool showOnFocus);

Request the virtual keyboard on focus, default true. Requires VirtualKeyboardEnabled and platform support. Explicit Edit can request it even when false.

Parameters
NameTypeDefault
showOnFocusbool—
showOnFocus

Request the virtual keyboard on focus, default true. Requires VirtualKeyboardEnabled and platform support. Explicit Edit can request it even when false.

SetVirtualKeyboardTypevoid
# SetVirtualKeyboardType
C#
public void SetVirtualKeyboardType(LineEdit.VirtualKeyboardTypeEnum type);

Keyboard-type hint to the platform, default Default. Number/EmailAddress and other values do not filter Text or replace input validation.

Parameters
NameTypeDefault
typeLineEdit.VirtualKeyboardTypeEnum—
type

Keyboard-type hint to the platform, default Default. Number/EmailAddress and other values do not filter Text or replace input validation.

Uneditvoid
# Unedit
C#
public void Unedit();

Ends active editing, applies current IME composition and hides the virtual keyboard where applicable. Does not release focus or itself emit EditingToggled. Deselection depends on DeselectOnFocusLossEnabled and drag state.

Signals and events4

EditingToggledEvent
# EditingToggled
C#
public event LineEdit.EditingToggledEventHandler EditingToggled;

Notification from focus paths, user actions and Editable changes. Not universal observation of IsEditing: direct Edit/Unedit with existing focus may not emit it. Read IsEditing in the handler for current state.

Handler parameters
NameTypeDefault
toggledOnbool—
toggledOn

State reported by this notification path; read IsEditing for actual state.

TextChangeRejectedEvent
# TextChangeRejected
C#
public event LineEdit.TextChangeRejectedEventHandler TextChangeRejected;

Part of an insertion exceeded MaxLength. Supplies the discarded tail while the available prefix is accepted. Can occur during SetText or MaxLength assignment even without TextChanged.

Handler parameters
NameTypeDefault
rejectedSubstringstring—
rejectedSubstring

Insertion tail exceeding the codepoint limit.

TextChangedEvent
# TextChanged
C#
public event LineEdit.TextChangedEventHandler TextChanged;

Text-change notification from user editing and some programmatic operations. Text/SetText and InsertTextAtCaret do not themselves emit it; Clear and DeleteCharAtCaret emit immediately, DeleteText deferred in the tree. Do not treat it as universal observation of every Text write.

Handler parameters
NameTypeDefault
newTextstring—
newText

Original field text at notification time, without masking or placeholder.

TextSubmittedEvent
# TextSubmitted
C#
public event LineEdit.TextSubmittedEventHandler TextSubmitted;

Submission through ui_text_submit, usually Enter. Supplies current original text; assigning Text does not emit it. Validate under application rules before saving.

Handler parameters
NameTypeDefault
newTextstring—
newText

Original field text at notification time, without masking or placeholder.

LineEdit.ExpandMode

ValueDescription
FitToLineEdit = 2

Scale the right icon to fit the LineEdit.

FitToText = 1

Scale the right icon's size to match the size of the text.

OriginalSize = 0

Use the original size for the right icon.

LineEdit.MenuItems

ValueDescription
Clear = 3

Erases the whole LineEdit text.

Copy = 1

Copies the selected text.

Cut = 0

Cuts (copies and clears) the selected text.

DirAuto = 9

Sets text direction to automatic.

DirInherited = 8

Sets text direction to inherited.

DirLtr = 10

Sets text direction to left-to-right.

DirRtl = 11

Sets text direction to right-to-left.

DisplayUcc = 12

Toggles control character display.

EmojiAndSymbol = 30

Opens system emoji and symbol picker.

InsertAlm = 21

Inserts Arabic letter mark (ALM) character.

InsertFsi = 24

Inserts first strong isolate (FSI) character.

InsertLre = 16

Inserts start of left-to-right embedding (LRE) character.

InsertLri = 22

Inserts left-to-right isolate (LRI) character.

InsertLrm = 14

Inserts left-to-right mark (LRM) character.

InsertLro = 18

Inserts start of left-to-right override (LRO) character.

InsertPdf = 20

Inserts pop direction formatting (PDF) character.

InsertPdi = 25

Inserts pop direction isolate (PDI) character.

InsertRle = 17

Inserts start of right-to-left embedding (RLE) character.

InsertRli = 23

Inserts right-to-left isolate (RLI) character.

InsertRlm = 15

Inserts right-to-left mark (RLM) character.

InsertRlo = 19

Inserts start of right-to-left override (RLO) character.

InsertShy = 29

Inserts soft hyphen (SHY) character.

InsertWj = 28

Inserts word joiner (WJ) character.

InsertZwj = 26

Inserts zero width joiner (ZWJ) character.

InsertZwnj = 27

Inserts zero width non-joiner (ZWNJ) character.

Max = 31

Represents the size of the LineEdit.MenuItems enum.

Paste = 2

Pastes the clipboard text over the selected text (or at the caret's position). Non-printable escape characters are automatically stripped from the OS clipboard via String.strip_escapes.

Redo = 6

Reverse the last undo action.

SelectAll = 4

Selects the whole LineEdit text.

SubmenuInsertUcc = 13

ID of "Insert Control Character" submenu.

SubmenuTextDir = 7

ID of "Text Writing Direction" submenu.

Undo = 5

Undoes the previous action.

LineEdit.VirtualKeyboardTypeEnum

ValueDescription
Default = 0

Default text virtual keyboard.

EmailAddress = 5

Virtual keyboard with additional keys to assist with typing email addresses.

Multiline = 1

Multiline virtual keyboard.

Number = 2

Virtual number keypad, useful for PIN entry.

NumberDecimal = 3

Virtual number keypad, useful for entering fractional numbers.

Password = 6

Virtual keyboard for entering a password. On most platforms, this should disable autocomplete and autocapitalization. Note: This is not supported on Web. Instead, this behaves identically to LineEdit.VirtualKeyboardTypeEnum.Default.

Phone = 4

Virtual phone number keypad.

Url = 7

Virtual keyboard with additional keys to assist with typing URLs.

Theme properties

These are Theme resource keys, not C# properties. Use the matching Control GetTheme…() and AddTheme…Override() methods for each value type.

Key and typeDescription
caret_color
Color

Color of the LineEdit's caret (text cursor). This can be set to a fully transparent color to hide the caret entirely.

Default: Color(0.95, 0.95, 0.95, 1)
clear_button_color
Color

Color used as default tint for the clear button.

Default: Color(0.875, 0.875, 0.875, 1)
clear_button_color_pressed
Color

Color used for the clear button when it's pressed.

Default: Color(1, 1, 1, 1)
font_color
Color

Default font color.

Default: Color(0.875, 0.875, 0.875, 1)
font_outline_color
Color

The tint of text outline of the LineEdit.

Default: Color(0, 0, 0, 1)
font_placeholder_color
Color

Font color for LineEdit.PlaceholderText.

Default: Color(0.875, 0.875, 0.875, 0.6)
font_selected_color
Color

Font color for selected text (inside the selection rectangle).

Default: Color(1, 1, 1, 1)
font_uneditable_color
Color

Font color when editing is disabled.

Default: Color(0.875, 0.875, 0.875, 0.5)
selection_color
Color

Color of the selection rectangle.

Default: Color(0.5, 0.5, 0.5, 1)
caret_width
int

The caret's width in pixels. Greater values can be used to improve accessibility by ensuring the caret is easily visible, or to ensure consistency with a large font size.

Default: 1
minimum_character_width
int

Minimum horizontal space for the text (not counting the clear button and content margins). This value is measured in count of 'W' characters (i.e. this number of 'W' characters can be displayed without scrolling).

Default: 4
outline_size
int

The size of the text outline. Note: If using a font with FontFile.MultichannelSignedDistanceField enabled, its FontFile.MsdfPixelRange must be set to at least twice the value of LineEdit.outline_size for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.

Default: 0
font
Font

Font used for the text.

font_size
int

Font size of the LineEdit's text.

clear
Texture2D

Texture for the clear button. See LineEdit.ClearButtonEnabled.

caret_move_rejected_sound
AudioStream

Played when the caret is attempted to be moved using the arrow keys, [kbd]Home[/kbd], [kbd]End[/kbd], [kbd]Page Up[/kbd], or [kbd]Page Down[/kbd], but the caret doesn't actually move since it's already at the beginning/end of the text.

caret_moved_sound
AudioStream

Played when the caret is moved using the arrow keys, [kbd]Home[/kbd], [kbd]End[/kbd], [kbd]Page Up[/kbd], [kbd]Page Down[/kbd], or mouse clicks.

focus_sound
AudioStream

Played when this LineEdit receives keyboard or gamepad-induced focus. Mouse or touch-induced focus does not play a focus sound.

text_change_rejected_sound
AudioStream

Played when a text change is rejected (for instance, when pressing Backspace while there is no text or when LineEdit.MaxLength is exceeded).

text_changed_sound
AudioStream

Played when text is successfully changed through keyboard input (physical or virtual).

text_submitted_sound
AudioStream

Played when text is submitted using the ui_text_submit action.

focus
StyleBox

Background used when LineEdit has GUI focus. The LineEdit.focus StyleBox is displayed over the base StyleBox, so a partially transparent StyleBox should be used to ensure the base StyleBox remains visible. A StyleBox that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a StyleBoxEmpty resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.

normal
StyleBox

Default background for the LineEdit.

read_only
StyleBox

Background used when LineEdit is in read-only mode (LineEdit.Editable is set to false).

Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.