ContainerModule Class

Summary

A base class for modules that contain a collection of child modules.
Assembly
Wyam.Common.dll
Namespace
Wyam.Common.Modules
Interfaces
Base Types
  • Object
Derived Types
graph BT Type-->Base0["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type-.->Interface1["IModuleList"] click Interface1 "/api/Wyam.Common.Modules/IModuleList" Type-.->Interface2["IList<IModule>"] Type["ContainerModule"] class Type type-node Derived0["GroupBy"]-->Type click Derived0 "/api/Wyam.Core.Modules.Control/GroupBy" Derived1["GroupByMany"]-->Type click Derived1 "/api/Wyam.Core.Modules.Control/GroupByMany" Derived2["ForEach"]-->Type click Derived2 "/api/Wyam.Core.Modules.Control/ForEach" Derived3["ModuleCollection"]-->Type click Derived3 "/api/Wyam.Core.Modules.Extensibility/ModuleCollection" Derived4["Concat"]-->Type click Derived4 "/api/Wyam.Core.Modules.Control/Concat" Derived5["FrontMatter"]-->Type click Derived5 "/api/Wyam.Core.Modules.Control/FrontMatter" Derived6["Branch"]-->Type click Derived6 "/api/Wyam.Core.Modules.Control/Branch" Derived7["Paginate"]-->Type click Derived7 "/api/Wyam.Core.Modules.Control/Paginate" Derived8["Merge"]-->Type click Derived8 "/api/Wyam.Core.Modules.Control/Merge" Derived9["Sidecar"]-->Type click Derived9 "/api/Wyam.Core.Modules.Control/Sidecar" Derived10["ConcatBranch"]-->Type click Derived10 "/api/Wyam.Core.Modules.Control/ConcatBranch"

Syntax

public abstract class ContainerModule : IModule, IModuleList, IList<IModule>

Constructors

Name Summary
ContainerModule(IEnumerable<IModule>) Creates a new container module with the specified child modules. Any null items in the sequence of modules will be discarded.

Properties

Name Value Summary
Count int
IsReadOnly bool
this[int] IModule
this[string] IModule
Gets the module with the specified name.

Methods

Name Value Summary
Add(IModule) void
Add(IModule[]) void
Adds modules to the list. Any null items in the sequence of modules will be discarded.
Add(string, IModule) void
Adds a module to the list with a specified name.
AsKeyValuePairs() IEnumerable<KeyValuePair<string, IModule>>
Returns the list as a sequence of key-value pairs with the keys being the module names and the values being the module instances.
Clear() void
Contains(IModule) bool
Contains(string) bool
Determines if the list contains a module with the specified name.
CopyTo(IModule[], int) void
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.
GetEnumerator() IEnumerator<IModule>
IndexOf(IModule) int
IndexOf(string) int
Gets the index of the module with the specified name.
Insert(int, IModule) void
Insert(int, IModule[]) void
Inserts modules into the list. Any null items in the sequence of modules will be discarded.
Insert(int, string, IModule) void
Inserts a module into the list with a specified name.
Remove(IModule) bool
Remove(string) bool
Removes a module by name.
RemoveAt(int) void
TryGetValue(string, IModule) bool
Attempts to get a module with the specified name.
GitHub