Interface IStructureEditor<T>

An editor for hierarchical structures.

Namespace: NanoByte.StructureEditor
Assembly: NanoByte.StructureEditor.dll
Syntax
public interface IStructureEditor<T>
    where T : class
Type Parameters
Name Description
T

The type of object to edit.

Methods

Describe<TContainer>()

Adds a ContainerDescription<TContainer> used to describe the structure of the data being editing.

Declaration
IContainerDescription<TContainer> Describe<TContainer>()
    where TContainer : class
Returns
Type Description
IContainerDescription<TContainer>

The ContainerDescription<TContainer> for use in a "Fluent API" style.
Type Parameters
Name Description
TContainer

The type of the container to describe.

DescribeRoot(String)

Set up handling for the root element with a generic editor.

Declaration
IContainerDescription<T> DescribeRoot(string name)
Parameters
Type Name Description
String name

The name of the root element.
Returns
Type Description
IContainerDescription<T>

DescribeRoot<TEditor>(String)

Set up handling for the root element with a custom editor.

Declaration
IContainerDescription<T> DescribeRoot<TEditor>(string name)
    where TEditor : INodeEditor<T>, new()
Parameters
Type Name Description
String name

The name of the root element.
Returns
Type Description
IContainerDescription<T>
Type Parameters
Name Description
TEditor

An editor for modifying the content of the root.