CompositionChapter

References
public sealed class CompositionChapter
A named and organised collection of proxy sections.

Constructors

CompositionChapter

#
public CompositionChapter(string name, Text sortKey, Color? colour, params CompositionSection[] sections)
Create a new chapter.
name (string)
sortKey (Prose.Text)
colour (Color?)
sections (params CompositionSection[])

Properties

Colour

#
public Color? Colour { get; }
Gets the colour associated with this chapter.

Name

#
public string Name { get; }
Gets the name of this chapter.

Sections

#
public CompositionSection[] Sections { get; }
Gets the sections which make up this chapter.

SortKey

#
public Prose.Text SortKey { get; }
Gets the sorting key of this chapter. If the key is not set, the name ought to be used for sorting.

Methods

Insert

#
Insert a collection of items into this chapter.
item (CompositionItem)

Remove

#
public CompositionChapter Remove(Selector selector, List<CompositionItem> list)
Remove all indicated items from this chapter.
selector (Selector)Selector pattern.
list (List<CompositionItem>)All removed items will be appended to this list.

WithColour

#
public CompositionChapter WithColour(Color? colour)
Modify the colour of this chapter.
colour (Color?)

Convertors

OperationResultDescription
implicitCompositionItemCompositionChapterCreate a chapter with a single item.