{"id":43160163,"url":"https://github.com/nano-byte/structure-editor","last_synced_at":"2026-02-17T00:03:03.738Z","repository":{"id":34439209,"uuid":"157417757","full_name":"nano-byte/structure-editor","owner":"nano-byte","description":"WinForms library for building split-screen editors for data structures","archived":false,"fork":false,"pushed_at":"2025-12-30T14:13:43.000Z","size":6935,"stargazers_count":12,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-03T02:36:08.038Z","etag":null,"topics":["editor","split-screen","winforms","xml"],"latest_commit_sha":null,"homepage":"https://structure-editor.nano-byte.net","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nano-byte.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-11-13T17:15:10.000Z","updated_at":"2025-12-30T14:13:47.000Z","dependencies_parsed_at":"2023-02-16T06:30:56.174Z","dependency_job_id":"11800d8c-c806-4898-9888-d3ae549bfc96","html_url":"https://github.com/nano-byte/structure-editor","commit_stats":null,"previous_names":[],"tags_count":61,"template":false,"template_full_name":null,"purl":"pkg:github/nano-byte/structure-editor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nano-byte%2Fstructure-editor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nano-byte%2Fstructure-editor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nano-byte%2Fstructure-editor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nano-byte%2Fstructure-editor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nano-byte","download_url":"https://codeload.github.com/nano-byte/structure-editor/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nano-byte%2Fstructure-editor/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28963431,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-01T00:42:38.011Z","status":"ssl_error","status_checked_at":"2026-02-01T00:42:35.920Z","response_time":128,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["editor","split-screen","winforms","xml"],"created_at":"2026-02-01T01:16:42.545Z","updated_at":"2026-02-01T01:16:43.360Z","avatar_url":"https://github.com/nano-byte.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NanoByte Structure Editor\n\n[![Build](https://github.com/nano-byte/structure-editor/actions/workflows/build.yml/badge.svg)](https://github.com/nano-byte/structure-editor/actions/workflows/build.yml)\n[![NuGet](https://img.shields.io/nuget/v/NanoByte.StructureEditor.WinForms.svg)](https://www.nuget.org/packages/NanoByte.StructureEditor.WinForms/)\n[![API documentation](https://img.shields.io/badge/api-docs-orange.svg)](https://structure-editor.nano-byte.net/)  \nNanoByte Structure Editor is a WinForms library that helps you build split-screen editors for your data structures, consisting of:\n\n1. a collapsible tree-view of the data structure,\n2. a graphical editor for the currently selected node in the tree (`PropertyGrid` or custom) and\n3. a text editor (based on [ICSharpCode.TextEditor](https://github.com/nano-byte/ICSharpCode.TextEditor)) with a serialized (XML) representation of the currently selected node.\n\nThis allows you to create an IDE-like experience for your users when editing complex domain specific languages, configuration files, etc..\n\n![Screenshot](https://raw.githubusercontent.com/nano-byte/structure-editor/master/doc/screenshot.png)\n\n## Usage\n\nAdd a reference to the [NanoByte.StructureEditor.WinForms](https://www.nuget.org/packages/NanoByte.StructureEditor.WinForms/) NuGet package to your project. It is available for .NET Framework 2.0+ and .NET 6.0+.\n\n### Initialization\n\nCreate an instance of `StructureEditor\u003cT\u003e` and add it to your Form:\n```csharp\nvar editor = new StructureEditor\u003cMyData\u003e();\nControls.Add(editor);\n```\n\nAlternatively, you may want to derive your own class from `StructureEditor\u003cT\u003e`. This will allow you to use the graphical WinForms designer in Visual Studio (which does not support generic types) to place the Editor on your Form.\n```csharp\npublic class MyDataEditor : StructureEditor\u003cMyData\u003e\n{}\n```\n\nYou need to \"describe\" your data structure to the Editor. You can do this directly after instantiating the editor or in the constructor of your derived class.\n- Call `DescribeRoot()` and then use the fluent API provided as a return value to describe the properties on your main data type.\n- Call `Describe\u003cTContainer\u003e()` to describe the properties on a data type `TContainer` exposed by another property. You can use multiple calls with different type parameters to describe arbitrarily deep hierarchies.  \n\nThe fluent API provides the following methods:\n- `.AddProperty()` describes a simple value property.\n- `.AddPlainList()` describes a non-polymorphic list.\n- `.AddList()` describes a polymorphic list. After calling it you need to chain `.AddElement()` calls for each specific type of element the list can hold.\n\nThere are numerous overloads for each of these methods, e.g., allowing you to specify a custom editor control for a data type or to keep the auto-generated one.\n\n```csharp\neditor.DescribeRoot(\"Address Book\")\n      .AddPlainList(\"Group\", x =\u003e x.Groups);\neditor.Describe\u003cIContactContainer\u003e()\n      .AddPlainList(\"Contact\", x =\u003e x.Contacts);\neditor.Describe\u003cContact\u003e()\n      .AddProperty(\"Home Address\", x =\u003e PropertyPointer.For(() =\u003e x.HomeAddress))\n      .AddProperty(\"Work Address\", x =\u003e PropertyPointer.For(() =\u003e x.WorkAddress))\n      .AddList(x =\u003e x.PhoneNumbers)\n      .AddElement(\"Landline Number\", new LandlineNumber())\n      .AddElement(\"Mobile Number\", new MobileNumber());\n```\n\n### Storage\n\nUse the `Open()` method to load an XML file into the editor:\n```csharp\neditor.Open(CommandManager\u003cAddressBook\u003e.Load(path));\n```\n\nUse the `Save()` method on the `CommandManager` property to save the editor's content as an XML file:\n```csharp\neditor.CommandManager.Save(path);\n```\n\nTake a look a the [sample project](src/Sample) for a more complete setup, including undo/redo functionality.\n\n## Building\n\nThe source code is in [`src/`](src/), config for building the API documentation is in [`doc/`](doc/) and generated build artifacts are placed in `artifacts/`. The source code does not contain version numbers. Instead the version is determined during CI using [GitVersion](https://gitversion.net/).\n\nTo build install [Visual Studio 2022 v17.13 or newer](https://www.visualstudio.com/downloads/) and run `.\\build.ps1`.\n\n## Contributing\n\nWe welcome contributions to this project such as bug reports, recommendations and pull requests.\n\nThis repository contains an [EditorConfig](http://editorconfig.org/) file. Please make sure to use an editor that supports it to ensure consistent code style, file encoding, etc.. For full tooling support for all style and naming conventions consider using JetBrains' [ReSharper](https://www.jetbrains.com/resharper/) or [Rider](https://www.jetbrains.com/rider/) products.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnano-byte%2Fstructure-editor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnano-byte%2Fstructure-editor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnano-byte%2Fstructure-editor/lists"}