Concat Class

Summary

Executes modules and concatenates their output with the input documents.

Assembly

Namespace

Wyam.Core.Modules.Control

Interfaces

Base Types

Object
ContainerModule

graph BT Type-->Base0["ContainerModule"] click Base0 "/api/Wyam.Common.Modules/ContainerModule" Base0-->Base1["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["Concat"] class Type type-node

Syntax

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

Remarks

The specified modules are executed with an empty initial document and then outputs the original input documents without modification concatenated with the results from the specified module sequence.

Constructors

Name	Summary
Concat(IEnumerable<IModule>)	Executes the specified modules with an empty initial input document.
Concat(IModule[])	Executes the specified modules with an empty initial input document.

Properties

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

Methods

Name	Value	Summary
Add(IModule)	void	Inherited from ContainerModule
Add(IModule[])	void	Adds modules to the list. Any `null` items in the sequence of modules will be discarded. Inherited from ContainerModule
Add(string, IModule)	void	Adds a module to the list with a specified name. Inherited from ContainerModule
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. Inherited from ContainerModule
Clear()	void	Inherited from ContainerModule
Contains(IModule)	bool	Inherited from ContainerModule
Contains(string)	bool	Determines if the list contains a module with the specified name. Inherited from ContainerModule
CopyTo(IModule[], int)	void	Inherited from ContainerModule
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>	Inherited from ContainerModule
IndexOf(IModule)	int	Inherited from ContainerModule
IndexOf(string)	int	Gets the index of the module with the specified name. Inherited from ContainerModule
Insert(int, IModule)	void	Inherited from ContainerModule
Insert(int, IModule[])	void	Inserts modules into the list. Any `null` items in the sequence of modules will be discarded. Inherited from ContainerModule
Insert(int, string, IModule)	void	Inserts a module into the list with a specified name. Inherited from ContainerModule
Remove(IModule)	bool	Inherited from ContainerModule
Remove(string)	bool	Removes a module by name. Inherited from ContainerModule
RemoveAt(int)	void	Inherited from ContainerModule
TryGetValue(string, IModule)	bool	Attempts to get a module with the specified name. Inherited from ContainerModule
Where(Func<IExecutionContext, IDocument, IReadOnlyList<IDocument>, bool>)	Concat	Specifies a predicate to use when determining which documents to concatenate with the original list.