CODE Editor documentation
This is the main manual for the browser editor and the .NET 10 CODE.Editor.WinForms.TextEditor control, as delivered with 0.4.0-preview.1. It includes the custom preview pipeline and preview-only CSS. The JavaScript component's internal API version is 3, independently of the NuGet version.
The editor provides visual content editing and source editing over a separate document model. The host chooses the storage format, permitted features, toolbar, persistence, and image storage. The WinForms control embeds its web assets in its DLL and exposes typed .NET properties, methods, and events.
This manual supersedes the earlier milestone descriptions wherever they conflict with the current implementation. It distinguishes implemented behavior from remaining acceptance work. This is still a preview implementation, not a promise of full Markdown conformance or completed mobile qualification.
Start here
| Your task | Read first | Then read |
|---|---|---|
| Integrate with Olympus or another WinForms application | WinForms quick start | Saving, properties |
| Embed in a website | Web quick start | JavaScript API |
Expand ##currentevents## or style a blog preview |
Preview rendering | Events and types |
| Restrict formatting or require clean Markdown | Formats and policy | Editing |
| Add image paste/drop/upload | Images and clipboard | Host integration |
| Maintain the editor | Architecture | Testing, roadmap |
Complete contents
- Overview and feature map
- Web quick start
- WinForms quick start
- Formats and editing policy
- Editing behavior and keyboard shortcuts
- Lists and tables
- Preview rendering, customization and CSS
- Images and clipboard
- State, selection, history and saving
- JavaScript API reference
- WinForms property reference
- WinForms method reference
- WinForms events, enums and data types
- Web, ASP.NET, Photino and WebView2 integration
- Architecture and maintenance
- Security and performance
- Testing and troubleshooting
- Roadmap and known limitations
Essential integration rules
- Save a validated snapshot, persist its
Value/value, then acknowledge that exact revision. WinFormsEditorTextis a useful synchronous cache, not the complete save protocol. - Change content through commands. The rendered DOM is a view, not the authoritative document or persistence format.
- Choose storage format separately from view mode and source language.
- Preview transformations do not modify the stored document.
- The host must store pasted/dropped image files and return durable URLs.
- Policy diagnostics, unfinished image imports, and active composition may prevent a committed save.
Delivery and paths
| Delivery | Contents |
|---|---|
CODE-Editor-PoC.zip |
Browser demo and JS sources; ASP.NET and Photino examples; WinForms example/class library; tests; this docs/ directory |
CODE-Editor-Standalone.zip |
Small .NET 10 solution; reusable control and embedded assets; local NuGet package; tests; this docs/ directory |
CODE.Editor.WinForms.0.4.0-preview.1.nupkg |
Control DLL with embedded assets and WebView2 dependency metadata; not published to a public feed |
CODE-Editor-Documentation.zip |
This manual as individual linked Markdown files |
In the full project, runtime JavaScript is at the project root and the class library is under webview2/CODE.Editor.WinForms/. In the standalone project, runtime JavaScript is under CODE.Editor.WinForms/Assets/. Examples state their assumed root. No external JavaScript editor framework, npm package, or CDN reference is required.
The preceding implementation delivery recorded 100 passing Node tests, 13 passing browser interaction checks, and 18 passing native checks, including a NuGet-only consumer without loose web assets. These counts describe the exercised scenarios. Photino runtime integration, mobile devices, IME combinations, screen readers, and real Word/Outlook clipboard interchange still need acceptance testing.
Examples that refer to a host function explicitly identify it. Those functions are application code you supply, not undocumented editor APIs.