TextEdit

public TextEdit();

Creates an editable empty control with one logical line and empty undo history. Configure UI attachment and size separately.

public TextServer.AutowrapMode AutowrapMode { get; set; }

Visual wrapping rule with WrapMode.Boundary: Arbitrary uses grapheme boundaries, Word uses words, WordSmart can split an oversized word, and Off disables soft wrapping. Does not enable Boundary by itself.

public bool BackspaceDeletesCompositeCharacterEnabled { get; set; }

With true, normal Backspace deletes to the previous composite-character boundary; false deletes one code point. CaretMidGrapheme true takes priority and also selects one-code-point deletion. Does not control RemoveText with an explicit range.

public bool CaretBlink { get; set; }

Enables text-caret blinking. The timer runs while focused; false disables blinking rather than hiding the caret. Visibility still depends on focus and other drawing conditions. Configure timing with CaretBlinkInterval.

public float CaretBlinkInterval { get; set; }

Positive caret-visibility toggle interval in seconds. For example, 0.5 toggles every half second; a complete visible/hidden cycle takes two intervals. Zero does not disable blinking: use CaretBlink false. This is not a key-repeat delay.

public bool CaretDrawWhenEditableDisabled { get; set; }

Allows caret drawing with Editable false, subject to the remaining visibility conditions. Does not allow input or make the control editable. Leave false for ordinary text viewing without a caret.

public bool CaretMidGrapheme { get; set; }

Allows caret/deletion behavior inside composite characters. With true, Backspace deletes one code point even if BackspaceDeletesCompositeCharacterEnabled is enabled. Does not mean operating on halves of a UTF-16 surrogate pair.

public bool CaretMoveOnRightClick { get; set; }

Allows moving the caret by right-clicking. Assigning this property does not move it or enable the context menu; configure ContextMenuEnabled separately.

public bool CaretMultiple { get; set; }

Allows multiple carets. false immediately removes secondary carets, resets multicaret-edit state and blocks AddCaret. Do not toggle this setting inside BeginMulticaretEdit/EndMulticaretEdit.

public TextEdit.CaretTypeEnum CaretType { get; set; }

Text-caret shape: Line or Block. Block changes drawing but does not enable character replacement: configure OvertypeMode separately. Does not change text or caret positions.

public bool ContextMenuEnabled { get; set; }

Allows the user to open the built-in context menu. false neither deletes the PopupMenu nor prevents programmatic GetMenu or MenuOption calls. This is an interface setting, not an editing restriction; use Editable to control input.

public string CustomWordSeparators { get; set; }

Additional word-separator characters for the editor’s text system. Assigning the string does not enable them; use UseCustomWordSeparators. Not a regex and does not change the fixed WholeWords boundary checks in Search.

public bool DeselectOnFocusLossEnabled { get; set; }

Controls deselection on focus loss. false retains selection when another control receives focus. Switching false to true while this editor is unfocused immediately clears an existing selection. Does not edit text or transfer focus.

public bool DragAndDropSelectionEnabled { get; set; }

Allows the user to drag selected text through TextEdit’s drag-and-drop handling. Does not create a selection, perform a transfer on assignment or automatically enable file/project-object drops. Selection separately requires SelectingEnabled.

public bool DrawControlChars { get; set; }

Allows the text system to display control characters. Does not remove them from the document or sanitize/validate input text.

public bool DrawSpaces { get; set; }

Shows space markers without changing Text or selection rules. Presentation rather than adding characters to a file.

public bool DrawTabs { get; set; }

Shows visual tab markers while retaining document text. Does not enable Tab input or convert tabs into spaces.

public bool Editable { get; set; }

Allows user editing; default true. false also blocks Undo/Redo actions, but not programmatic Text, SetLine, InsertTextAtCaret or RemoveText. This is a UI mode rather than model-data protection.

public bool EmojiMenuEnabled { get; set; }

Allows the context-menu emoji command when the platform supports a system picker. false disables the corresponding item rather than necessarily removing it. Editable is also required. Does not add an emoji font or guarantee a system picker on every platform.

public bool EmptySelectionClipboardEnabled { get; set; }

Allows default Copy and Cut to operate on full lines when no text is selected. Defaults to true. Does not mean copying an empty string: it copies the entire caret line, which Cut may remove. Does not affect selected-text handling; assigning the property does not access the clipboard.

public bool HighlightAllOccurrences { get; set; }

Highlights case-sensitive whole-word matches of caret 0’s selected text. Empty or whitespace-only selections are ignored. Creates no additional selections and does not set SetSearchText. Differs from AddSelectionForNextOccurrence, which allows substring matches.

public bool HighlightCurrentLine { get; set; }

Highlights the background of current caret lines using the theme color. This is visual highlighting rather than text selection: HasSelection and GetSelectedText are unchanged. Use Select for an explicit range.

public bool IndentWrappedLines { get; set; }

Adds visual indentation to wrapped continuations. Does not insert spaces/tabs or change text or logical line numbers.

public string Language { get; set; }

Text-shaping language hint, such as ar; an empty string uses the locale. Does not translate the document or switch application language. Changes shaping/glyph selection while retaining Text.

public bool MiddleMousePasteEnabled { get; set; }

Allows middle-mouse paste through the primary-selection clipboard on supporting platforms. Does not add primary-clipboard support or control ordinary Paste. false disables this input path but does not block programmatic PastePrimaryClipboard. Assigning the property inserts nothing.

public bool MinimapDraw { get; set; }

Shows the document minimap. It takes part of TextEdit’s width, so enabling it can change the number of display rows when wrapping is enabled. Source Text and logical line count remain unchanged. Set its width with MinimapWidth.

public int MinimapWidth { get; set; }

Minimap area width in control pixels. Use a nonnegative value that leaves room for the main text. This is not a minimap font scale. Changing it recalculates available wrap width; use MinimapDraw false to disable the minimap.

public string PlaceholderText { get; set; }

Empty-editor hint, separate from Text. GetPlaceholder returns the source string; presentation uses UI translation. Not part of document saving, searching or content history.

public bool ScrollFitContentHeight { get; set; }

Include content in the control’s minimum height. A parent container can expand the editor instead of using internal scrolling. Does not change font size or add lines.

public bool ScrollFitContentWidth { get; set; }

Include content in the control’s minimum width. A layout requirement rather than fixed width or text zoom; account for interaction with wrapping.

public int ScrollHorizontal { get; set; }

Horizontal offset in pixels. Clamped to the internal scrollbar range; wrapping can eliminate the available horizontal range. Not a text column number.

public bool ScrollPastEndOfFile { get; set; }

Allows extra scrolling space beyond text end. Does not add empty document lines or increase GetLineCount.

public bool ScrollSmooth { get; set; }

Enables smooth vertical scrolling. Does not change ScrollVertical units or guarantee animation for every programmatic SetVScroll.

public float ScrollVScrollSpeed { get; set; }

Smooth vertical scrolling speed, at least 1. Does not set the current offset or represent line height or a horizontal step size.

public double ScrollVertical { get; set; }

Vertical offset in visual-row units, allowing a fractional part. Not pixels or always a logical line number: use GetScrollPosForLine with wrapping. The getter returns the actual clamped value.

public bool SelectingEnabled { get; set; }

Allows text selection. Disabling clears existing selections but does not block caret movement through Select or make the document read-only. Configure Editable separately.

public bool SelectionHandleEnabled { get; set; }

Enables on-screen selection handles for touch input. Does not enable selection itself; configure SelectingEnabled separately. Does not control the number of carets or replace CaretMultiple.

public bool ShortcutKeysEnabled { get; set; }

Enables built-in editing-command shortcuts and their context-menu accelerator labels. Does not disable all keyboard input or block programmatic commands. Use Editable false to prevent user text editing.

public TextServer.StructuredTextParser StructuredTextBidiOverride { get; set; }

Structured-text parser for mixed LTR/RTL: URI, path, email, list and other supported modes. Controls separator presentation rather than converting document encoding. Configure parser options separately.

public Reckfell.Collections.Array StructuredTextBidiOverrideOptions { get; set; }

Shared Array of BiDi parser options. The setter compares contents and skips equal values; merely assigning Duplicate with old contents does not detach the previous array. In-place mutation does not trigger text recalculation. Supply a separately prepared array and a new array with changed contents when updating.

public SyntaxHighlighter SyntaxHighlighter { get; set; }

This editor’s highlighting resource; null disables highlighting. Use one instance per TextEdit because the resource stores only one context. Reassigning the same resource is skipped and does not replace ClearHighlightingCache/EmitChanged.

public bool TabInputMode { get; set; }

Controls editor handling of the Tab key. Does not convert existing tab characters, set their width or automatically translate indentation to spaces.

public string Text { get; set; }

Full text with \n line separators. Assignment replaces the document, emits TextSet without TextChanged and allows Undo with history enabled. For a newly loaded document, explicitly clear history and mark the saved version afterward.

public Control.TextDirection TextDirection { get; set; }

Base text direction: Inherited follows Control layout, Auto derives it from text, and Ltr/Rtl set it explicitly. Does not translate or reverse stored Text. Document character order remains logical.

public bool UseCustomWordSeparators { get; set; }

Enables CustomWordSeparators for word-boundary processing. Independent of UseDefaultWordSeparators; both sets can be used together. Does not switch Search into WholeWords mode.

public bool UseDefaultWordSeparators { get; set; }

Enables the text system’s default word separators. Disabling does not enable custom separators automatically; configure UseCustomWordSeparators separately. Does not change Search WholeWords boundary checks.

public bool VirtualKeyboardEnabled { get; set; }

Allows the on-screen keyboard when supported by the current platform. Assigning true does not itself open it. VirtualKeyboardShowOnFocus separately controls opening on focus; editing requires Editable. Does not build a custom keyboard from UI controls.

public bool VirtualKeyboardShowOnFocus { get; set; }

Allows requesting the on-screen keyboard on focus. Requires VirtualKeyboardEnabled, Editable and platform support. false disables focus-triggered opening rather than every other keyboard-opening path.

public TextEdit.LineWrappingMode WrapMode { get; set; }

None disables visual wrapping; Boundary constrains lines to available control width. AutowrapMode chooses break points. Does not insert line separators or change GetLineCount; gutters, scrollbar, theme and minimap also affect available width.

public int AddCaret(int line, int column);

Adds a caret and returns its index; -1 when CaretMultiple is disabled or the position overlaps an existing caret/selection outside a multicaret edit. Position is clamped to the document. Inside BeginMulticaretEdit, a new caret is temporarily ignored by the current operation until EndMulticaretEdit.

public void AddCaretAtCarets(bool below);

Adds a caret one visible display row above or below each original caret, preserving the visual horizontal position and corresponding selection span. Requires CaretMultiple. With wrapping, the target may be another part of the same logical line; hidden lines are skipped. No caret is added beyond document edges; duplicate positions are merged.

public void AddGutter(int at = -1);

Adds a field beside the text and cells for every logical line. at within 0…Count inserts at that index; a negative value or one above Count appends. Later gutter indices shift. A new gutter is String, width 24, drawn, non-clickable and non-overwritable. Emits GutterAdded without an index.

public void AddSelectionForNextOccurrence();

Adds a selection for the next literal match of the last indexed caret’s selection. Requires SelectingEnabled and CaretMultiple. With no selection, the first call only selects the word. Search is case-sensitive, allows substrings and wraps; multiline queries are unsupported. Matches may overlap, so merging need not increase the caret count. Does not edit text.

public void AdjustCaretsAfterEdit(int caret, int fromLine, int fromCol, int toLine, int toCol);

Obsolete no-op. Current edit operations adjust carets themselves; remove this call from new code.

public void AdjustViewportToCaret(int caretIndex = 0);

Scrolls the viewport to reveal the specified caret without moving it. Use current layout after text/size changes. Explicitly choose the intended index in multicaret mode.

public void ApplyIme();

Applies the current IME composition through the insertion path and closes it. Does not save a document file. Invoke from a coordinated editable context rather than using it for ordinary programmatic string insertion.

public void Backspace(int caretIndex = -1);

Runs deletion before the caret. The default implementation requires Editable; joins lines at line start and does nothing at document start. If the target set contains a selection, deletes selections without deleting characters at other unselected carets. Defaults to all eligible carets. An overridden _Backspace completely replaces the default path.

public void BeginComplexOperation();

Begins an edit group for one Undo. Supports nested groups; balance each Begin with EndComplexOperation in finally. Not a model transaction and does not defer all signals until the group ends.

public void BeginMulticaretEdit();

Begins a multicaret-processing scope: merging is deferred and new carets can be marked ignored. End with EndMulticaretEdit in finally; scopes can nest. Use BeginComplexOperation separately for Undo grouping: these are different mechanisms.

public void CancelIme();

Cancels unfinished IME composition and updates its presentation. Does not revert committed Text or replace Undo for previous edits.

public void CenterViewportToCaret(int caretIndex = 0);

Centers the viewport around the specified caret within scroll limits. Does not create a selection or move the caret.

public void Clear();

Clears text and emits TextSet. An empty document retains one line. With Editable true and history enabled, the operation is undoable; with Editable false it clears history. Distinct from ClearUndoHistory, which retains text.

public void ClearUndoHistory();

Removes Undo/Redo while retaining current text. Also resets the GetSavedVersion marker. Retag with TagSavedVersion after loading if needed; clearing history does not save anything to disk.

public void CollapseCarets(int fromLine, int fromColumn, int toLine, int toColumn, bool inclusive = false);

Moves carets and affected selection boundaries inside the range to the original fromLine/fromColumn position. Reversed bounds are normalized for membership, but the target remains the original from position. inclusive includes both edges; both are excluded by default. Fully contained selections are cleared, partial selections shortened, and duplicate carets merged. Merging can be deferred inside a multicaret-edit scope. Text and Undo history are unchanged.

public void Copy(int caretIndex = -1);

The default implementation copies selected text to the system clipboard without editing the document. With caretIndex -1, selections are joined by newlines in document order. Without a selection, EmptySelectionClipboardEnabled permits copying full lines with a trailing newline; multiple carets on one line do not duplicate it. With that setting disabled and no selection, leaves the clipboard unchanged. Works with Editable false. Overriding _Copy replaces this behavior.

public void Cut(int caretIndex = -1);

The default implementation first copies text, then, when Editable, removes selections or full lines if EmptySelectionClipboardEnabled allows it. With Editable false, the document is unchanged but copying can still occur. Undo restores the document, not the previous system clipboard. Cut’s internal copying does not call a custom _Copy; override _Cut to replace the whole action.

public void DeleteSelection(int caretIndex = -1);

Deletes selected text and collapses affected selections. By default, processes all eligible carets and groups deletion into one Undo step. A specific caretIndex limits the operation to one caret. Programmatic calls work independently of Editable.

public void Deselect(int caretIndex = -1);

Clears selection while retaining caret positions and text. caretIndex -1 affects all carets; a specific index affects one. Does not remove secondary carets.

public void EndAction();

Marks a boundary in the current StartAction action; not Undo, rollback or an immediate text reset. Group completion can be processed with the next action. Use StartAction with another type or None to switch groups explicitly.

public void EndComplexOperation();

Closes one undo-group level. A completed outer group combines nested changes into one history step. Call in finally for its matching BeginComplexOperation.

public void EndMulticaretEdit();

Closes a multicaret-edit level. Leaving the outer scope performs pending merges and clears ignored indices. Does not replace EndComplexOperation for Undo history.

public TextServer.AutowrapMode GetAutowrapMode();

Visual wrapping rule with WrapMode.Boundary: Arbitrary uses grapheme boundaries, Word uses words, WordSmart can split an oversized word, and Off disables soft wrapping. Does not enable Boundary by itself.

public float GetCaretBlinkInterval();

Positive caret-visibility toggle interval in seconds. For example, 0.5 toggles every half second; a complete visible/hidden cycle takes two intervals. Zero does not disable blinking: use CaretBlink false. This is not a key-repeat delay.

public int GetCaretColumn(int caretIndex = 0);

Active endpoint column in Unicode code points. Not a pixel position, UTF-16 index or guaranteed boundary of one visible character.

public int GetCaretCount();

Number of user carets, at least 1. Excludes the temporary drag caret. Indices apply only to the current set and can change after merging/removal.

public Vector2 GetCaretDrawPos(int caretIndex = 0);

Last computed local caret drawing position. Depends on the current frame/layout; use GetCaretLine/GetCaretColumn to retain a document position.

public int[] GetCaretIndexEditOrder();

Obsolete reverse index order. Current editing APIs adjust carets themselves; use GetSortedCarets when sorting is needed rather than relying on the old manual-edit order.

public int GetCaretLine(int caretIndex = 0);

Logical line of the specified caret’s active endpoint, not the anchor line or visual wrap index.

public TextEdit.CaretTypeEnum GetCaretType();

Text-caret shape: Line or Block. Block changes drawing but does not enable character replacement: configure OvertypeMode separately. Does not change text or caret positions.

public int GetCaretWrapIndex(int caretIndex = 0);

Visual segment of the current logical line containing the specified caret. Does not change the caret index or document line.

public string GetCustomWordSeparators();

Additional word-separator characters for the editor’s text system. Assigning the string does not enable them; use UseCustomWordSeparators. Not a regex and does not change the fixed WholeWords boundary checks in Search.

public bool GetDrawControlChars();

Allows the text system to display control characters. Does not remove them from the document or sanitize/validate input text.

public int GetFirstNonWhiteSpaceColumn(int line);

Unicode code-point column of the first non-whitespace character. A tab occupies one column even when its visual indentation is wider. For an all-whitespace line, returns its length.

public int GetFirstVisibleLine();

Logical line number at the top of the viewport. When scrolled into a long line, its first visual segment can already be above the viewport; does not return a wrapIndex.

public int GetGutterCount();

Number of gutter definitions, including hidden ones. Use this count to test for no gutters rather than comparing GetTotalGutterWidth with zero.

public string GetGutterName(int gutter);

Stored gutter-definition name rather than a per-line label or guaranteed unique ID.

public TextEdit.GutterType GetGutterType(int gutter);

Gutter presentation mode, default String. Does not report whether individual line data is populated.

public int GetGutterWidth(int gutter);

Stored width of one gutter, excluding shared padding. Hiding the gutter does not reset it.

public int GetHScroll();

Horizontal offset in pixels. Clamped to the internal scrollbar range; wrapping can eliminate the available horizontal range. Not a text column number.

public HScrollBar GetHScrollBar();

Internal HScrollBar owned by TextEdit. Do not free or reparent it separately; freeing the editor frees the scrollbar. Use ScrollHorizontal for ordinary scrolling.

public int GetIndentLevel(int line);

Leading indentation amount: tab count multiplied by GetTabSize plus leading spaces. Not the first-content column or a syntax-tree nesting level.

public string GetLanguage();

Text-shaping language hint, such as ar; an empty string uses the locale. Does not translate the document or switch application language. Changes shaping/glyph selection while retaining Text.

public int GetLastFullVisibleLine();

Logical line number of the bottom fully fitting visual row. Also read GetLastFullVisibleLineWrapIndex to distinguish segments of a wrapped line.

public int GetLastFullVisibleLineWrapIndex();

Index of the bottom fully fitting visual segment within GetLastFullVisibleLine. Not a standalone document line number.

public int GetLastUnhiddenLine();

Returns the last logical line index not hidden by a derived editor’s folding system. In ordinary TextEdit without hiding, this is GetLineCount() - 1. Does not mean the last line in the current scrolled viewport; use viewport methods for that. An empty document has line 0.

public string GetLine(int line);

Logical-line text without the \n separator. Indices start at 0. An invalid index returns an empty string, so check GetLineCount first when an error must be distinguished from an empty document line.

public Color GetLineBackgroundColor(int line);

Stored additional logical-line background rather than the final color including theme and selection.

public Vector2I GetLineColumnAtPos(Vector2I position, bool allowOutOfBounds);

Converts a TextEdit-local position to Vector2I: X is a Unicode code-point column and Y a logical line. clampLine/clampColumn control text-layout clamping; an unavailable position can return (-1, -1). Not a universal control hit-test: check the local control area first. The old overload’s allowOutOfBounds actually forwards as clampLine with clampColumn always true. Prefer the three-argument overload for clarity.

public Vector2I GetLineColumnAtPos(Vector2I position, bool clampLine = true, bool clampColumn = true);

Converts a TextEdit-local position to Vector2I: X is a Unicode code-point column and Y a logical line. clampLine/clampColumn control text-layout clamping; an unavailable position can return (-1, -1). Not a universal control hit-test: check the local control area first. The old overload’s allowOutOfBounds actually forwards as clampLine with clampColumn always true. Prefer the three-argument overload for clarity.

public int GetLineCount();

Number of logical lines, including empty ones; an empty document has 1. Visual wrapping of a long line does not add logical lines.

public Texture2D GetLineGutterIcon(int line, int gutter);

Shared cell icon resource or null. Not a texture copy or proof that the gutter currently displays an icon.

public Color GetLineGutterItemColor(int line, int gutter);

Stored cell text/icon color rather than the line background or main document text color.

public Variant GetLineGutterMetadata(int line, int gutter);

Returns the stored Variant. Containers remain shared with the original value. Dispose the C# Variant wrapper after use; this does not delete the gutter or model record.

public string GetLineGutterText(int line, int gutter);

Stored gutter-cell label. Retained even with another GutterType or a hidden gutter.

public int GetLineHeight();

Visual-row pixel height including theme spacing, at least 1. Need not equal the font size and is not a logical-line count.

public Reckfell.Collections.Array<Vector2I> GetLineRangesFromCarets(bool onlySelections = false, bool mergeAdjacent = true);

New Vector2I array of logical-line ranges: X is the first and Y the last included line. onlySelections excludes unselected carets; mergeAdjacent merges adjacent ranges. When a selection ends at column 0, that end line is excluded.

public int GetLineWidth(int line, int wrapIndex = -1);

Shaped-text width in pixels. wrapIndex -1 requests the line buffer size; otherwise measures a particular visual segment. With wrapping enabled, not the width of a hypothetical unwrapped full line.

public string GetLineWithIme(int line);

Presentation line including temporary IME composition when it affects that line. Matches GetLine without composition. Save through Text/GetLine to avoid recording unfinished input as committed text.

public int GetLineWrapCount(int line);

Number of additional visual wraps in the line. Zero means one segment; total segments equal Count + 1. Not the document GetLineCount.

public int GetLineWrapIndexAtColumn(int line, int column);

Index of the visual segment containing a logical-line column. Columns count Unicode code points; the line end is valid too. Returns 0 without wrapping; not a document line number.

public string[] GetLineWrappedText(int line);

New array of visual segments of one logical line; without wrapping contains one element. Can include temporary IME text. Read Text to save a document. Editing the array does not modify the editor.

public TextEdit.LineWrappingMode GetLineWrappingMode();

None disables visual wrapping; Boundary constrains lines to available control width. AutowrapMode chooses break points. Does not insert line separators or change GetLineCount; gutters, scrollbar, theme and minimap also affect available width.

public Vector2 GetLocalMousePos();

Returns the mouse position in TextEdit coordinates, mirroring X as Width - X for RTL layout. This is neither a global screen position nor text line/column coordinates. Differs from ordinary GetLocalMousePosition in RTL.

public PopupMenu GetMenu();

Returns the built-in PopupMenu, creating it on first access without opening it. Repeated calls return the same object. TextEdit owns and frees the menu: do not Free or Dispose this borrowed object. MenuItems defines built-in command IDs; use distinct IDs for application items.

public int GetMinimapLineAtPos(Vector2I position);

Computes a minimap logical line from a control-local vertical position, accounting for scrolling, wrapping and hiding. Clamps the result to document line bounds. Does not test X or return -1 merely because the point is outside the minimap: check its rectangle first.

public int GetMinimapVisibleLines();

Returns the minimap’s vertical row capacity: available height divided by minimap row height plus spacing. This is neither the document line count nor the number of rows actually containing text. Use GetLineCount for logical lines.

public int GetMinimapWidth();

Minimap area width in control pixels. Use a nonnegative value that leaves room for the main text. This is not a minimap font scale. Changing it recalculates available wrap width; use MinimapDraw false to disable the minimap.

public int GetNextCompositeCharacterColumn(int line, int column);

Next composite-character boundary from TextServer-shaped text. Input and result are Unicode code-point columns rather than UTF-16 indices. At line end, returns the same end column. One visible composite character can span more than one column.

public Vector2I GetNextVisibleLineIndexOffsetFrom(int line, int wrapIndex, int visibleAmount);

Traverses visible rows including wrapping and hidden lines. Vector2I.X is the count of traversed logical lines including the starting line, not an absolute index; Y is the destination wrap-part index. The sign of visibleAmount selects direction. For nonzero traversal, compute the destination as line + X - 1 downward or line - X + 1 upward and validate bounds. For example, reaching the second display row within the same logical line returns (1, 1). visibleAmount 0 returns (0, 0).

public int GetNextVisibleLineOffsetFrom(int line, int visibleAmount);

Counts traversed logical lines while visiting visible lines, including the starting line; hidden lines count toward the result but not as visible lines. The sign of visibleAmount selects direction; the result is nonnegative. This is a count, not a destination index or pixel distance. Without hiding it returns Abs(visibleAmount), even beyond document bounds: validate the computed index. For a nonempty traversal, the destination is line + result - 1 downward or line - result + 1 upward.

public string GetPlaceholder();

Empty-editor hint, separate from Text. GetPlaceholder returns the source string; presentation uses UI translation. Not part of document saving, searching or content history.

public Vector2I GetPosAtLineColumn(int line, int column);

Local character reference point: GetRectAtLineColumn position plus (0, GetLineHeight()). A bottom point rather than the rectangle’s top-left corner. Depends on the drawing cache and returns (-1, -1) when unavailable.

public int GetPreviousCompositeCharacterColumn(int line, int column);

Previous composite-character boundary in Unicode code-point columns. Returns 0 at line start. Do not always subtract 1 for user deletion: combining marks can form one composite character.

public Rect2I GetRectAtLineColumn(int line, int column);

Character/grapheme rectangle in TextEdit-local coordinates from the latest drawing cache. An unavailable/undrawn position returns (-1, -1, 0, 0); an empty document is a special case with an empty Rect2I at the origin. Query after layout/drawing rather than retaining permanent document coordinates.

public uint GetSavedVersion();

Last TagSavedVersion marker; ClearUndoHistory resets it. Does not prove that a disk file exists or is current.

public double GetScrollPosForLine(int line, int wrapIndex = 0);

Vertical position of a logical line and its wrapIndex in visual-row units. Without wrapping/hiding, equals the logical line number. Can be passed to SetVScroll, which can clamp it to the available range.

public string GetSelectedText(int caretIndex = -1);

Selection text without modifying the document. With caretIndex -1, joins nonempty selections in document order with a newline; this is not one original contiguous range. Read each caret explicitly to retain separate fragments. Returns an empty string without selection.

public int GetSelectionAtLineColumn(int line, int column, bool includeEdges = true, bool onlySelections = true);

Index of the first caret/selection containing the position, or -1. includeEdges controls boundary inclusion; onlySelections excludes unselected carets. With overlaps, returns the first matching index rather than all matches.

public int GetSelectionColumn(int caretIndex = 0);

Obsolete alias for GetSelectionOriginColumn. Explicitly choose the Origin anchor or normalized From start in new code.

public int GetSelectionFromColumn(int caretIndex = 0);

Normalized start column paired with GetSelectionFromLine. Without selection, the caret column. Counts Unicode code points rather than UTF-16 indices.

public int GetSelectionFromLine(int caretIndex = 0);

Earlier boundary of the active selection in document order. Without selection, returns the caret line. Not always the anchor line.

public int GetSelectionLine(int caretIndex = 0);

Obsolete alias for GetSelectionOriginLine rather than the normalized start. Use Origin or GetSelectionFromLine as appropriate in new code.

public TextEdit.SelectionMode GetSelectionMode();

Returns the selection-processing mode, such as Pointer or Word. This does not test whether text is selected: use HasSelection. None mode does not by itself mean there is no selection.

public int GetSelectionOriginColumn(int caretIndex = 0);

Anchor column in Unicode code points. Can follow the active caret in a backward selection; use GetSelectionFromColumn for the normalized start.

public int GetSelectionOriginLine(int caretIndex = 0);

Selection-anchor line for the specified caret. This is the original gesture endpoint rather than necessarily the lower line number. Check HasSelection before treating it as an active selection boundary.

public int GetSelectionToColumn(int caretIndex = 0);

Exclusive end column paired with GetSelectionToLine. Without selection, the caret column. Not the selection length when multiple lines are involved.

public int GetSelectionToLine(int caretIndex = 0);

Later boundary of the active selection in document order. Without selection, returns the caret line. The final text position is exclusive.

public int[] GetSortedCarets(bool includeIgnoredCarets = false);

New index array ordered top-to-bottom by normalized selection start or caret position. Does not change actual indices or creation order. By default excludes temporarily ignored carets during a multicaret edit. Do not retain the array after the caret set changes.

public TextServer.StructuredTextParser GetStructuredTextBidiOverride();

Structured-text parser for mixed LTR/RTL: URI, path, email, list and other supported modes. Controls separator presentation rather than converting document encoding. Configure parser options separately.

public Reckfell.Collections.Array GetStructuredTextBidiOverrideOptions();

Shared Array of BiDi parser options. The setter compares contents and skips equal values; merely assigning Duplicate with old contents does not detach the previous array. In-place mutation does not trigger text recalculation. Supply a separately prepared array and a new array with changed contents when updating.

public SyntaxHighlighter GetSyntaxHighlighter();

This editor’s highlighting resource; null disables highlighting. Use one instance per TextEdit because the resource stores only one context. Reassigning the same resource is skipped and does not replace ClearHighlightingCache/EmitChanged.

public bool GetTabInputMode();

Controls editor handling of the Tab key. Does not convert existing tab characters, set their width or automatically translate indentation to spaces.

public int GetTabSize();

Stored tab width for layout rather than the number of tab characters in the document.

public string GetText();

Full text with \n line separators. Assignment replaces the document, emits TextSet without TextChanged and allows Undo with history enabled. For a newly loaded document, explicitly clear history and mark the saved version afterward.

public Control.TextDirection GetTextDirection();

Base text direction: Inherited follows Control layout, Auto derives it from text, and Ltr/Rtl set it explicitly. Does not translate or reverse stored Text. Document character order remains logical.

public int GetTotalGutterWidth();

Sum of drawn gutter widths plus internal padding. Current implementation limitation: hiding or removing all previously drawn gutters can leave 2 pixels of padding. Use GetGutterCount to test whether definitions exist; this is not one gutter’s width.

public int GetTotalVisibleLineCount();

Total document visual-row count: logical lines plus wraps, excluding hidden lines when hiding is supported. Not limited to the current scrolled viewport.

public double GetVScroll();

Vertical offset in visual-row units, allowing a fractional part. Not pixels or always a logical line number: use GetScrollPosForLine with wrapping. The getter returns the actual clamped value.

public VScrollBar GetVScrollBar();

Internal VScrollBar owned by TextEdit. Do not free or reparent it separately; freeing the editor frees the scrollbar. Values are visual rows rather than pixels.

public float GetVScrollSpeed();

Smooth vertical scrolling speed, at least 1. Does not set the current offset or represent line height or a horizontal step size.

public uint GetVersion();

Identifier of the current editing-history state rather than an engine version or text hash. Undo can restore an earlier value. Compare with GetSavedVersion within the current document and history.

public bool GetVirtualKeyboardShowOnFocus();

Allows requesting the on-screen keyboard on focus. Requires VirtualKeyboardEnabled, Editable and platform support. false disables focus-triggered opening rather than every other keyboard-opening path.

public int GetVisibleLineCount();

Number of whole visual rows that fit in the control height. View capacity rather than the number of document lines currently drawn.

public int GetVisibleLineCountInRange(int fromLine, int toLine);

Visual-row count in a logical-line range with both endpoints included. Accounts for wrapping/hiding and normalizes reversed arguments. Does not count only the rows currently visible on screen.

public string GetWordAtPos(Vector2 position);

Returns the text-system word at a control-local position, accounting for scrolling and wrapping. Does not move the caret or create a selection. Returns an empty string when no word/text is hit. Supply control coordinates rather than screen coordinates; word rules are not a C# parser.

public string GetWordUnderCaret(int caretIndex = -1);

Returns the TextServer-bounded word near a caret. caretIndex -1 can join words from multiple carets with newlines in index order rather than document order. Supply an explicit index for one word. Not a Search operation or C# compiler identifier analysis.

public bool HasImeText();

Whether temporary IME composition text exists. Not a test for Editable, a connected keyboard or unsaved document changes.

public bool HasRedo();

Whether an undone operation is available for redo. Executing Redo additionally requires Editable true.

public bool HasSelection(int caretIndex = -1);

Whether a caret has an active selection. Default caretIndex -1 checks any caret, while 0 checks only the main caret. Does not mean document text changed.

public bool HasUndo();

Whether an undo operation exists, including a pending current record. Does not grant permission to Undo: Editable must be true.

public void InsertLineAt(int line, string text);

Inserts text and a line separator before an existing logical line. line must be less than GetLineCount; Count is not an append command. Inserted text can contain additional line separators. One Undo reverses the operation.

public void InsertText(string text, int line, int column, bool beforeSelectionBegin = true, bool beforeSelectionEnd = false);

Inserts text at the supplied position without deleting an existing selection. Adjusts carets and selection bounds; beforeSelectionBegin/End control insertion exactly at a boundary. Undoable and works with Editable false. Use InsertTextAtCaret to replace selection.

public void InsertTextAtCaret(string text, int caretIndex = -1);

Inserts text, replaces the target caret’s selection and moves it to the insertion end. caretIndex -1 processes all eligible carets; 0 targets the main caret. Programmatic calls also work with Editable false. Supply an explicit index when only one insertion is intended in a multicaret editor.

public bool IsBackspaceDeletesCompositeCharacterEnabled();

With true, normal Backspace deletes to the previous composite-character boundary; false deletes one code point. CaretMidGrapheme true takes priority and also selects one-code-point deletion. Does not control RemoveText with an explicit range.

public bool IsCaretAfterSelectionOrigin(int caretIndex = 0);

Whether the active caret follows its anchor in document order. Use to retain selection direction; does not test whether a selection exists.

public bool IsCaretBlinkEnabled();

Enables text-caret blinking. The timer runs while focused; false disables blinking rather than hiding the caret. Visibility still depends on focus and other drawing conditions. Configure timing with CaretBlinkInterval.

public bool IsCaretMidGraphemeEnabled();

Allows caret/deletion behavior inside composite characters. With true, Backspace deletes one code point even if BackspaceDeletesCompositeCharacterEnabled is enabled. Does not mean operating on halves of a UTF-16 surrogate pair.

public bool IsCaretVisible(int caretIndex = 0);

Cached caret visibility from drawing. Not equivalent to caret existence, Editable or visibility of the whole logical line. Can be stale before current drawing.

public bool IsContextMenuEnabled();

Allows the user to open the built-in context menu. false neither deletes the PopupMenu nor prevents programmatic GetMenu or MenuOption calls. This is an interface setting, not an editing restriction; use Editable to control input.

public bool IsCustomWordSeparatorsEnabled();

Enables CustomWordSeparators for word-boundary processing. Independent of UseDefaultWordSeparators; both sets can be used together. Does not switch Search into WholeWords mode.

public bool IsDefaultWordSeparatorsEnabled();

Enables the text system’s default word separators. Disabling does not enable custom separators automatically; configure UseCustomWordSeparators separately. Does not change Search WholeWords boundary checks.

public bool IsDeselectOnFocusLossEnabled();

Controls deselection on focus loss. false retains selection when another control receives focus. Switching false to true while this editor is unfocused immediately clears an existing selection. Does not edit text or transfer focus.

public bool IsDragAndDropSelectionEnabled();

Allows the user to drag selected text through TextEdit’s drag-and-drop handling. Does not create a selection, perform a transfer on assignment or automatically enable file/project-object drops. Selection separately requires SelectingEnabled.

public bool IsDraggingCursor();

true during TextEdit’s internal selection or minimap dragging. This is control interaction state, not a global mouse-button test or detection of an arbitrary drag-and-drop operation.

public bool IsDrawingCaretWhenEditableDisabled();

Allows caret drawing with Editable false, subject to the remaining visibility conditions. Does not allow input or make the control editable. Leave false for ordinary text viewing without a caret.

public bool IsDrawingMinimap();

Shows the document minimap. It takes part of TextEdit’s width, so enabling it can change the number of display rows when wrapping is enabled. Source Text and logical line count remain unchanged. Set its width with MinimapWidth.

public bool IsDrawingSpaces();

Shows space markers without changing Text or selection rules. Presentation rather than adding characters to a file.

public bool IsDrawingTabs();

Shows visual tab markers while retaining document text. Does not enable Tab input or convert tabs into spaces.

public bool IsEditable();

Allows user editing; default true. false also blocks Undo/Redo actions, but not programmatic Text, SetLine, InsertTextAtCaret or RemoveText. This is a UI mode rather than model-data protection.

public bool IsEmojiMenuEnabled();

Allows the context-menu emoji command when the platform supports a system picker. false disables the corresponding item rather than necessarily removing it. Editable is also required. Does not add an emoji font or guarantee a system picker on every platform.

public bool IsEmptySelectionClipboardEnabled();

Allows default Copy and Cut to operate on full lines when no text is selected. Defaults to true. Does not mean copying an empty string: it copies the entire caret line, which Cut may remove. Does not affect selected-text handling; assigning the property does not access the clipboard.

public bool IsFitContentHeightEnabled();

Returns ScrollFitContentHeight rather than whether all text is visible without scrolling. Final size depends on the parent layout.

public bool IsFitContentWidthEnabled();

Returns ScrollFitContentWidth rather than testing the absence of horizontal scrolling. Final size depends on parent layout and wrapping.

public bool IsGutterClickable(int gutter);

The gutter’s own global flag rather than its effective OR with per-line IsLineGutterClickable or permission to execute a command.

public bool IsGutterDrawn(int gutter);

Whether drawing is enabled for the gutter definition. Does not test whether a particular line is inside the editor viewport.

public bool IsGutterOverwritable(int gutter);

Whether the gutter participates in MergeGutters. Not a user text-editing flag.