Content Class

Summary

Replaces the content of each input document with the string value of the specified content object.
Assembly
Wyam.Core.dll
Namespace
Wyam.Core.Modules.Contents
Interfaces
Base Types
graph BT Type-->Base0["ContentModule"] click Base0 "/api/Wyam.Common.Modules/ContentModule" Base0-->Base1["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type["Content"] class Type type-node

Syntax

public class Content : ContentModule, IModule

Remarks

In the case where modules are provided, they are executed against an empty initial document and the results are applied to each input document.

Constructors

Name Summary
Content(ContextConfig) Uses the string value of the returned object as the new content for each document. This allows you to specify different content depending on the execution context.
Content(DocumentConfig) Uses the string value of the returned object as the new content for each document. This allows you to specify different content for each document depending on the input document.
Content(IModule[]) The specified modules are executed against an empty initial document and the results are applied to every input document (possibly creating more than one output document for each input document).
Content(Object) Uses the string value of the specified object as the new content for every input document.

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.
Inherited from ContentModule
Execute(Object, IDocument, IExecutionContext) IEnumerable<IDocument>
Executes the module with the specified content against a single document. Note that content can be passed in as null, implementers should guard against that.
GitHub