Flatten Class

Summary

Flattens a tree structure given child documents are stored in a given metadata key ("Children" by default). The flattened documents are returned in no particular order.
Assembly
Wyam.Core.dll
Namespace
Wyam.Core.Modules.Metadata
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type["Flatten"] class Type type-node

Syntax

public class Flatten : IModule

Constructors

Name Summary
Flatten() Creates a new flatten module.
Flatten(string) Creates a new flatten module with the specified children key.

Methods

Name Value Summary
Execute(IReadOnlyList<IDocument>, IExecutionContext) IEnumerable<IDocument>
This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.
GitHub