https://github.com/frozenassassine/textcontrolbox-winui

Winui3 textbox with syntax highlighting, line numbering and much more
https://github.com/frozenassassine/textcontrolbox-winui

csharp syntaxhighlighting textbox textcontrolbox winui3

Last synced: 11 months ago
JSON representation

Winui3 textbox with syntax highlighting, line numbering and much more

• Host: GitHub
• URL: https://github.com/frozenassassine/textcontrolbox-winui
• Owner: FrozenAssassine
• License: mit
• Created: 2023-07-31T20:45:48.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2025-07-14T06:46:47.000Z (12 months ago)
• Last Synced: 2025-07-14T09:39:21.858Z (12 months ago)
• Topics: csharp, syntaxhighlighting, textbox, textcontrolbox, winui3
• Language: C#
• Homepage:
• Size: 649 KB
• Stars: 13
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          




TextControlBox-WinUI
















## 🤔 What is TextControlBox?

TextControlBox is a powerful and highly customizable textbox control for WinUI 3 applications. It provides an advanced text editing experience with features like syntax highlighting for multiple programming languages, intuitive search and replace functionality, zooming, line numbering, and smooth scrolling. With support for undo/redo, customizable themes, and efficient performance.

## 🛠️ Features

- **Basic Text Editing**: Cut, copy, paste, undo, redo, and full text selection capabilities.

- **Navigation & Selection**:

  - Go to a specific line.

  - Select specific lines or the entire text.

- **Scrolling & Zooming**:

  - Scroll to specific lines or pages.

  - Zoom in and out for better readability.

- **Syntax Highlighting**:

  - Built-in support for multiple programming languages.

  - Easily toggle syntax highlighting on and off.

- **Search & Replace**:

  - Multi highlight search

  - Find and replace text with options for case sensitivity and whole-word matching.

- **Customization Options**:

  - Show or hide line numbers.

  - Customize font, theme, and cursor appearance.

  - Configure spaces vs. tabs for indentation.

- **Other Features**:

  - Drag & drop text support.

  - Surround selected text with custom characters.

  - Get cursor position and manage selections programmatically.

## ❤️ Support my work  

  

    



## 🏗️ Getting Started

### Installation

### 📥 [Download Nuget.org](https://www.nuget.org/packages/TextControlBox.WinUI.JuliusKirsch/1.1.0-alpha)

Add TextControlBox to your WinUI 3 project and include the necessary namespace in your XAML or C# file.

```csharp

using TextControlBoxNS;

```

### Basic Usage

```csharp

TextControlBox textBox = new TextControlBox();

textBox.LoadText("Hello, world!");

textBox.ShowLineNumbers = true;

textBox.EnableSyntaxHighlighting = true;

```

🛠️ All properties and functions


- `Text`: Gets or sets the full content of the editor.

- `SelectedText`: Gets the currently selected text.

- `CurrentSelection`, `CurrentSelectionOrdered`: Provides selection metadata.

- `HasSelection`: Indicates if any text is currently selected.

- `CursorPosition`: Gets the current cursor position.

- `CurrentLineIndex`: Index of the line containing the cursor.

- `NumberOfLines`: Total number of lines in the editor.

- `FontFamily`: Gets or sets the font family.

- `FontSize`: Gets or sets the base font size.

- `RenderedFontSize`: Gets the final rendered font size.

- `CornerRadius`: Gets or sets the control's corner radius.

- `RequestedTheme`: Gets or sets the UI theme.

- `Design`: Gets or sets visual settings like line numbers and highlighting.

- `ShowLineNumbers`: Toggles line number visibility.

- `ShowLineHighlighter`: Toggles current line highlighting.

- `EnableSyntaxHighlighting`: Enables or disables syntax highlighting.

- `SyntaxHighlighting`: Gets or sets the current syntax highlighting language.

- `LineEnding`: Gets or sets the line ending mode.

- `SpaceBetweenLineNumberAndText`: Spacing between line numbers and text.

- `ZoomFactor`: Gets or sets the zoom factor.

- `VerticalScroll`, `HorizontalScroll`: Gets or sets scroll offsets.

- `VerticalScrollSensitivity`, `HorizontalScrollSensitivity`: Adjust scroll speed.

- `UseSpacesInsteadTabs`: Enables space-based tabulation.

- `NumberOfSpacesForTab`: Sets number of spaces per tab.

- `SearchIsOpen`: Indicates whether the search panel is open.

- `Lines`: Gets all lines as strings.

- `DoAutoPairing`: Enables auto-pairing of brackets/quotes.

- `ControlW_SelectWord`: Enables Ctrl+W to select the current word.

- `CanDragDropText`: Enables drag-and-drop support.

- `ContextFlyout`: Gets or sets the context menu flyout.

- `ContextFlyoutDisabled`: Disables the context menu.

- `IsReadonly`: Determines if the control is read-only.

- `CursorSize`: Gets or sets the cursor size.

- `Focus(FocusState state)`: Sets focus to the control.

- `SelectLine(int line)`: Selects a specific line.

- `SelectLines(int start, int count)`: Selects a range of lines.

- `GoToLine(int line)`: Moves the cursor to a specific line.

- `LoadText(string text)`: Loads text into the control.

- `SetText(string text)`: Sets the text content.

- `LoadLines(IEnumerable lines, LineEnding lineEnding = LineEnding.CRLF)`: Loads multiple lines.

- `Paste()`: Pastes clipboard content.

- `Copy()`: Copies the selection to clipboard.

- `Cut()`: Cuts the selected text.

- `GetText()`: Returns the current content.

- `SetSelection(int start, int length)`: Selects a specific text range.

- `SelectAll()`: Selects all text.

- `ClearSelection()`: Clears any text selection.

- `Undo()`: Undoes the last action.

- `Redo()`: Redoes the last undone action.

- `ScrollLineToCenter(int line)`: Scrolls a line to center.

- `ScrollOneLineUp()`, `ScrollOneLineDown()`: Scrolls one line vertically.

- `ScrollLineIntoView(int line)`: Brings a line into view.

- `ScrollTopIntoView()`, `ScrollBottomIntoView()`: Scrolls to top/bottom.

- `ScrollPageUp()`, `ScrollPageDown()`: Scrolls a full page.

- `ScrollIntoViewHorizontally()`: Scrolls horizontally into view.

- `GetLineText(int line)`: Returns the text of a line.

- `GetLinesText(int startLine, int length)`: Returns a range of lines.

- `SetLineText(int line, string text)`: Replaces the text of a line.

- `DeleteLine(int line)`: Deletes a specific line.

- `AddLine(int line, string text)`: Adds a new line at a position.

- `SurroundSelectionWith(string text)`: Surrounds selection with a string.

- `SurroundSelectionWith(string text1, string text2)`: Surrounds with prefix/suffix.

- `DuplicateLine(int line)`: Duplicates the specified line.

- `DuplicateCurrentLine()`: Duplicates the current line.

- `ReplaceAll(string word, string replaceWord, bool matchCase, bool wholeWord)`: Replaces all matches.

- `ReplaceNext(string replaceWord)`: Replaces the next match.

- `FindNext()`, `FindPrevious()`: Navigates search results.

- `BeginSearch(string word, bool wholeWord, bool matchCase)`: Starts a search.

- `EndSearch()`: Ends the search.

- `Unload()`: Unloads the control.

- `ClearUndoRedoHistory()`: Clears undo/redo history.

- `GetCursorPosition()`: Returns the cursor's screen position.

- `SetCursorPosition(int lineNumber, int characterPos, bool scrollIntoView = true, bool autoClamp = true)`: Sets the cursor position.

- `SelectSyntaxHighlightingById(SyntaxHighlightID languageId)`: Sets highlighting by ID.

- `CalculateSelectionPosition()`: Gets position info for selection.

- `CharacterCount()`: Returns character count.

- `WordCount()`: Returns word count.

- `TextChanged`: Event triggered when text changes.

- `SelectionChanged`: Event triggered on selection change.

- `ZoomChanged`: Event triggered when zoom changes.

- `GotFocus`, `LostFocus`, `Loaded`: Focus and lifecycle events.

- `SyntaxHighlightings`: Static dictionary of syntax languages.

- `GetSyntaxHighlightingFromID(SyntaxHighlightID languageId)`: Gets highlighting language.

- `GetSyntaxHighlightingFromJson(string json)`: Loads highlighting from JSON.

## 🚀 Events

TextControlBox provides several events to handle user interactions:

- `TextChanged`: Triggered when the text content changes.

- `SelectionChanged`: Fires when the user changes the selected text.

- `ZoomChanged`: Called when the zoom factor is adjusted.

- `GotFocus` / `LostFocus`: Handle focus changes.

## 🎨 Syntax Highlighting

TextControlBox includes built-in support for multiple languages:

- C#, C++, Java, Python, JavaScript, JSON, HTML, CSS, SQL, Markdown, Batch, Config, CSV, LaTex, PHP, QSharp, TOML, XML

Enable syntax highlighting:

```csharp

textBox.SelectSyntaxHighlightingById(SyntaxHighlightID.CSharp);

```

## 👨‍👩‍👧‍👦 Contributing

Contributions are welcome! Feel free to submit a pull request or open an issue.

## 🧾 License

This project is licensed under the MIT License.