SweetEditor 1.0.4

SweetEditor for WinForms

A high-performance WinForms code editor control powered by the SweetEditor C++ core.

The C++ core handles text layout, cursor/selection logic, folding, decoration data, and interaction math; the WinForms layer provides native GDI+ rendering and input dispatch.

Features

• Syntax and semantic highlighting via style spans
• Inlay hints and ghost text
• Diagnostics and custom decorations
• Gutter icons and fold markers
• Code folding and word-wrap modes
• Current-line rendering modes (background / border)
• Indent guides, bracket guides, flow guides
• Linked editing (multi-cursor rename)
• Undo / Redo
• IME composition support
• Completion, decoration, and newline action provider extensions
• Monospace and proportional font support
• Pinch-to-zoom scaling

Requirements

• .NET 8+ (net8.0-windows)
• Windows x64
• Native runtime sweeteditor.dll is bundled in the NuGet package (runtimes/win-x64/native/)

Install

dotnet add package SweetEditor

Quick Start

using SweetEditor;

public sealed class MainForm : Form {
    private readonly SweetEditorControl editor = new() { Dock = DockStyle.Fill };

    public MainForm() {
        Controls.Add(editor);

        // Theme
        editor.ApplyTheme(EditorTheme.Dark());

        // Settings
        editor.Settings.SetEditorTextSize(14f);
        editor.Settings.SetFontFamily("Cascadia Code");
        editor.Settings.SetWrapMode(WrapMode.WORD_BREAK);
        editor.Settings.SetCurrentLineRenderMode(CurrentLineRenderMode.BORDER);

        // Load content
        editor.LoadDocument(new Document("int main() {\n    return 0;\n}\n"));
    }
}

Settings

All settings are available via editor.Settings and take effect immediately.

Theme and Styles

var theme = EditorTheme.Dark()
    .DefineTextStyle(EditorTheme.STYLE_KEYWORD,
        new TextStyle(unchecked((int)0xFF7AA2F7), SweetEditorControl.FONT_STYLE_BOLD));

editor.ApplyTheme(theme);

Events

editor.TextChanged      += (s, e) => { /* e.Action, e.Changes */ };
editor.CursorChanged    += (s, e) => { /* e.Position */ };
editor.SelectionChanged += (s, e) => { /* selection info */ };
editor.ScrollChanged    += (s, e) => { /* scroll info */ };
editor.ScaleChanged     += (s, e) => { /* new scale */ };
editor.DocumentLoaded   += (s, e) => { /* document ready */ };
editor.FoldToggle       += (s, e) => { /* fold state changed */ };
editor.ContextMenu      += (s, e) => { /* show context menu */ };

Text Editing

editor.InsertText("Hello");
editor.ReplaceText(new TextRange(new TextPosition(0, 0), new TextPosition(0, 5)), "Hi");
editor.DeleteText(range);
editor.SelectAll();
editor.SetSelection(0, 0, 0, 5);
editor.Undo();
editor.Redo();

Decorations

// Syntax spans
editor.SetLineSpans(line, SpanLayer.SYNTAX, spans);
editor.SetBatchLineSpans(SpanLayer.SYNTAX, spansByLine);

// Diagnostics
editor.SetLineDiagnostics(line, diagnostics);
editor.SetBatchLineDiagnostics(diagsByLine);

// Inlay hints, ghost text, gutter icons
editor.SetLineInlayHints(line, hints);
editor.SetLinePhantomTexts(line, phantoms);
editor.SetLineGutterIcons(line, icons);

// Guides
editor.SetIndentGuides(guides);
editor.SetBracketGuides(guides);
editor.SetFoldRegions(regions);

Extension Points

editor.AddDecorationProvider(myProvider);
editor.AddCompletionProvider(myCompletionProvider);
editor.AddNewLineActionProvider(myNewLineProvider);

Linked Editing

editor.StartLinkedEditing(model);
editor.LinkedEditingNext();
editor.LinkedEditingPrev();
editor.CancelLinkedEditing();

Build from Source

# 1. Build the native C++ shared library
.\scripts\build-shared.ps1 -Platform windows

# 2. Build and pack
dotnet build  .\platform\WinForms\SweetEditor\SweetEditor.csproj -c Release
dotnet pack   .\platform\WinForms\SweetEditor\SweetEditor.csproj -c Release

Output: platform/WinForms/SweetEditor/bin/Release/SweetEditor.<version>.nupkg

Publish

dotnet nuget push .\platform\WinForms\SweetEditor\bin\Release\SweetEditor.<version>.nupkg `
    --api-key <NUGET_API_KEY> `
    --source https://api.nuget.org/v3/index.json

License

LGPL-2.1+