ContentModule Class

Summary

This class can be used as a base class for modules that operate on arbitrary content (as represented by an object).
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["ContentModule"] class Type type-node Derived0["Replace"]-->Type click Derived0 "/api/Wyam.Core.Modules.Contents/Replace" Derived1["Prepend"]-->Type click Derived1 "/api/Wyam.Core.Modules.Contents/Prepend" Derived2["Trace"]-->Type click Derived2 "/api/Wyam.Core.Modules.Extensibility/Trace" Derived3["ReplaceIn"]-->Type click Derived3 "/api/Wyam.Core.Modules.Contents/ReplaceIn" Derived4["Content"]-->Type click Derived4 "/api/Wyam.Core.Modules.Contents/Content" Derived5["Append"]-->Type click Derived5 "/api/Wyam.Core.Modules.Contents/Append"

Syntax

public abstract class ContentModule : IModule

Constructors

Name Summary
ContentModule(ContextConfig) Creates a new content module with the specified content delegate.
ContentModule(DocumentConfig) Creates a new content module with the specified content delegate.
ContentModule(IModule[]) Creates a new content module with the content determined by child modules.
ContentModule(Object) Creates a new content module with the specified content.

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.
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