CDS.CSharpScript2.ScintillaEditor 4.1.0

CDS.CSharpScript2.ScintillaEditor

Scintilla5-based WinForms editor control for C# script editing, powered by Roslyn.

Description

CDS.CSharpScript2.ScintillaEditor provides a drop-in WinForms UserControl that gives your application a professional C# script editor backed by the Scintilla5 native editing component and full Roslyn IntelliSense.

Features

• Syntax highlighting — real Roslyn token classification (keywords, types, literals, comments, …).
• Code completion — member lists, type suggestions, and smart single-letter prioritisation.
• Signature help (call tips) — parameter info as you type method calls.
• Hover tooltips — type and XML-doc info on mouse hover.
• Error indicators — squiggles and a live diagnostic list tied to the Roslyn compiler.
• Code folding — fold and unfold regions; save and restore the folded state.
• Find/Replace — built-in find and replace dialog.
• Documentation panel — companion DocsPanel showing full XML docs for the symbol at the caret (F1).
• Output panel — companion RTFOutputPanel for displaying script results.
• Ready-made panel — ScriptEditorPanel combines the editor, output panel and docs panel in one control.

Quick Start

Add ScintillaScriptEditor to a form and wire up a ScriptEnvironment:

using CDS.CSharpScript2;
using CDS.CSharpScript2.ScintillaEditor;

var editor = new ScintillaScriptEditor();
editor.Dock = DockStyle.Fill;
Controls.Add(editor);

// Setting Environment starts live analysis immediately
editor.API.Environment = ScriptEnvironment.Default;

Compile and run the script the user has typed:

var executable = await editor.API.CompileAsync();

if (!executable.HasErrors)
    await executable.RunAsync();

All scripting properties and methods are accessed through editor.API to keep them separate from the standard WinForms Control surface.

API Surface (editor.API)

Documentation panel (F1)

DocsPanel is a plain UserControl that shows the full XML documentation for the symbol at the caret: signature, summary, parameters, returns, exceptions, remarks, overloads, and a type's members, with links between related symbols. Press F1 in the editor to bring it up; it then follows the caret, until you click a link (it then stays on the pages you choose, with Back and Forward) and F1 returns it to following the caret. Colours follow the editor's Theme.

The panel never shows or hides itself, so you decide where it lives (a fixed column, a docking pane, a tab, a floating form). Connect it to the editor and react to its two events:

var docsPanel = new DocsPanel { Visible = false, Width = 340, Dock = DockStyle.Right };
Controls.Add(docsPanel);

docsPanel.Editor = editor;
docsPanel.ShowRequested += (_, _) => docsPanel.Visible = true;    // F1 in the editor
docsPanel.CloseRequested += (_, _) => docsPanel.Visible = false;  // close button or Escape

If you hide the panel by some other means (a docking pane's own close button), call docsPanel.Close() so that F1 starts fresh. While nothing is subscribed to the editor's ScriptHelpRequested event (which the panel does when Editor is set), F1 opens the older provisional API information window instead.

See the CDS.CSharpScript2.WinForms.Sample project for a full working example.

Requirements

• .NET 10.0 (Windows) or .NET Framework 4.8
• x64 or ARM64 — Scintilla5 is a native library; AnyCPU is not supported at runtime

Dependencies

• CDS.CSharpScript2 — core scripting engine
• Scintilla5.NET — managed wrapper for Scintilla5

Attributions

Icon by Flaticon Uicons