IModuleList Interface

Summary

A collection of optionally named modules. Implementations should "unwrap" Wyam.Common.Modules.NamedModule objects to obtain the module name.
Assembly
Wyam.Common.dll
Namespace
Wyam.Common.Modules
Interfaces
Implementing Types
graph BT Type-.->Interface0["IList<IModule>"] Type["IModuleList"] class Type type-node Implementing0["Less"]-.->Type click Implementing0 "/api/Wyam.Web.Pipelines/Less" Implementing1["GroupBy"]-.->Type click Implementing1 "/api/Wyam.Core.Modules.Control/GroupBy" Implementing2["GroupByMany"]-.->Type click Implementing2 "/api/Wyam.Core.Modules.Control/GroupByMany" Implementing3["ApiSearchIndex"]-.->Type click Implementing3 "/api/Wyam.Docs.Pipelines/ApiSearchIndex" Implementing4["ForEach"]-.->Type click Implementing4 "/api/Wyam.Core.Modules.Control/ForEach" Implementing5["ModuleList"]-.->Type click Implementing5 "/api/Wyam.Common.Modules/ModuleList" Implementing6["ContainerModule"]-.->Type click Implementing6 "/api/Wyam.Common.Modules/ContainerModule" Implementing7["Archive"]-.->Type click Implementing7 "/api/Wyam.Web.Pipelines/Archive" Implementing8["RenderPages"]-.->Type click Implementing8 "/api/Wyam.Web.Pipelines/RenderPages" Implementing9["Redirects"]-.->Type click Implementing9 "/api/Wyam.Web.Pipelines/Redirects" Implementing10["ModuleCollection"]-.->Type click Implementing10 "/api/Wyam.Core.Modules.Extensibility/ModuleCollection" Implementing11["Concat"]-.->Type click Implementing11 "/api/Wyam.Core.Modules.Control/Concat" Implementing12["FrontMatter"]-.->Type click Implementing12 "/api/Wyam.Core.Modules.Control/FrontMatter" Implementing13["BlogPosts"]-.->Type click Implementing13 "/api/Wyam.Web.Pipelines/BlogPosts" Implementing14["Pipeline"]-.->Type click Implementing14 "/api/Wyam.Common.Execution/Pipeline" Implementing15["Branch"]-.->Type click Implementing15 "/api/Wyam.Core.Modules.Control/Branch" Implementing16["ApiIndex"]-.->Type click Implementing16 "/api/Wyam.Docs.Pipelines/ApiIndex" Implementing17["IfCondition"]-.->Type click Implementing17 "/api/Wyam.Core.Modules.Control/IfCondition" Implementing18["IPipeline"]-.->Type click Implementing18 "/api/Wyam.Common.Execution/IPipeline" Implementing19["RenderApi"]-.->Type click Implementing19 "/api/Wyam.Docs.Pipelines/RenderApi" Implementing20["RenderBlogPosts"]-.->Type click Implementing20 "/api/Wyam.Web.Pipelines/RenderBlogPosts" Implementing21["Paginate"]-.->Type click Implementing21 "/api/Wyam.Core.Modules.Control/Paginate" Implementing22["Sass"]-.->Type click Implementing22 "/api/Wyam.Web.Pipelines/Sass" Implementing23["Api"]-.->Type click Implementing23 "/api/Wyam.Docs.Pipelines/Api" Implementing24["Merge"]-.->Type click Implementing24 "/api/Wyam.Core.Modules.Control/Merge" Implementing25["Resources"]-.->Type click Implementing25 "/api/Wyam.Web.Pipelines/Resources" Implementing26["Sitemap"]-.->Type click Implementing26 "/api/Wyam.Web.Pipelines/Sitemap" Implementing27["Sidecar"]-.->Type click Implementing27 "/api/Wyam.Core.Modules.Control/Sidecar" Implementing28["ConcatBranch"]-.->Type click Implementing28 "/api/Wyam.Core.Modules.Control/ConcatBranch" Implementing29["ValidateLinks"]-.->Type click Implementing29 "/api/Wyam.Web.Pipelines/ValidateLinks" Implementing30["ConditionalPipeline"]-.->Type click Implementing30 "/api/Wyam.Web.Pipelines/ConditionalPipeline" Implementing31["TagIndex"]-.->Type click Implementing31 "/api/Wyam.Blog.Pipelines/TagIndex" Implementing32["Code"]-.->Type click Implementing32 "/api/Wyam.Docs.Pipelines/Code" Implementing33["Feeds"]-.->Type click Implementing33 "/api/Wyam.Web.Pipelines/Feeds" Implementing34["Pages"]-.->Type click Implementing34 "/api/Wyam.Web.Pipelines/Pages"

Syntax

public interface IModuleList : IList<IModule>

Properties

Name Value Summary
this[string] IModule
Gets the module with the specified name.

Methods

Name Value Summary
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.
Contains(string) bool
Determines if the list contains a module with the specified name.
IndexOf(string) int
Gets the index of the module with the specified name.
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(string) bool
Removes a module by name.
TryGetValue(string, IModule) bool
Attempts to get a module with the specified name.

Extension Methods

Name Value Summary
Append<IModuleList>(IModule[]) TModuleList
Appends modules.
Append<IModuleList>(string, IModule) TModuleList
Appends a named module.
GetFirst<TModule>() TModule
Gets the first module of the specified type.
GetFirst<TModule>(Predicate<TModule>) TModule
Gets the first module of the specified type.
GetLast<TModule>() TModule
Gets the last module of the specified type.
GetLast<TModule>(Predicate<TModule>) TModule
Gets the last module of the specified type.
IndexOfFirst<TModule>() int
Gets the index of the first module of the specified type.
IndexOfFirst<TModule>(Predicate<TModule>) int
Gets the index of the first module of the specified type.
IndexOfLast<TModule>() int
Gets the index of the last module of the specified type.
IndexOfLast<TModule>(Predicate<TModule>) int
Gets the index of the last module of the specified type.
InsertAfter<IModuleList>(string, IModule[]) TModuleList
Inserts modules after the module with the specified name.
InsertAfter<IModuleList>(string, string, IModule) TModuleList
Inserts modules after the module with the specified name.
InsertAfterFirst<TModule>(IModule[]) IModuleList
Inserts modules after the first module in the list of the specified type.
InsertAfterFirst<TModule>(Predicate<TModule>, IModule[]) IModuleList
Inserts modules after the first module in the list of the specified type that satisfies a predicate.
InsertAfterFirst<TModule>(Predicate<TModule>, string, IModule) IModuleList
Inserts modules after the first module in the list of the specified type that satisfies a predicate.
InsertAfterFirst<TModule>(string, IModule) IModuleList
Inserts modules after the first module in the list of the specified type.
InsertAfterLast<TModule>(IModule[]) IModuleList
Inserts modules after the last module in the list of the specified type.
InsertAfterLast<TModule>(Predicate<TModule>, IModule[]) IModuleList
Inserts modules after the last module in the list of the specified type that satisfies a predicate.
InsertAfterLast<TModule>(Predicate<TModule>, string, IModule) IModuleList
Inserts modules after the last module in the list of the specified type that satisfies a predicate.
InsertAfterLast<TModule>(string, IModule) IModuleList
Inserts modules after the last module in the list of the specified type.
InsertBefore<IModuleList>(string, IModule[]) TModuleList
Inserts modules before the module with the specified name.
InsertBefore<IModuleList>(string, string, IModule) TModuleList
Inserts modules before the module with the specified name.
InsertBeforeFirst<TModule>(IModule[]) IModuleList
Inserts modules before the first module in the list of the specified type.
InsertBeforeFirst<TModule>(Predicate<TModule>, IModule[]) IModuleList
Inserts modules before the first module in the list of the specified type that satisfies a predicate.
InsertBeforeFirst<TModule>(Predicate<TModule>, string, IModule) IModuleList
Inserts modules before the first module in the list of the specified type that satisfies a predicate.
InsertBeforeFirst<TModule>(string, IModule) IModuleList
Inserts modules before the first module in the list of the specified type.
InsertBeforeLast<TModule>(IModule[]) IModuleList
Inserts modules before the last module in the list of the specified type.
InsertBeforeLast<TModule>(Predicate<TModule>, IModule[]) IModuleList
Inserts modules before the last module in the list of the specified type that satisfies a predicate.
InsertBeforeLast<TModule>(Predicate<TModule>, string, IModule) IModuleList
Inserts modules before the last module in the list of the specified type that satisfies a predicate.
InsertBeforeLast<TModule>(string, IModule) IModuleList
Inserts modules before the last module in the list of the specified type.
Modify<IModuleList>(int, Action<IModule>) TModuleList
Modifies an inner module list with the specified index.
Modify<IModuleList>(string, Action<IModule>) TModuleList
Modifies an inner module with the specified name.
Prepend<IModuleList>(IModule[]) TModuleList
Prepends modules.
Prepend<IModuleList>(string, IModule) TModuleList
Prepends a named module.
Replace<IModuleList>(int, IModule, string) TModuleList
Replaces a module at the specified index.
Replace<IModuleList>(string, IModule, string) TModuleList
Replaces a module with the specified name. The replacement module will have the same name as the module being replaced unless an alternate name is specified.
ReplaceFirst<TModule>(IModule, string) IModuleList
Replaces the first module in the list of the specified type.
ReplaceFirst<TModule>(Predicate<TModule>, IModule, string) IModuleList
Replaces the first module in the list of the specified type that satisfies a predicate.
ReplaceLast<TModule>(IModule, string) IModuleList
Replaces the last module in the list of the specified type.
ReplaceLast<TModule>(Predicate<TModule>, IModule, string) IModuleList
Replaces the last module in the list of the specified type that satisfies a predicate.
GitHub