Replace Class

Summary

Replaces a search string in the content of each input document with new content.
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["Replace"] class Type type-node

Syntax

public class Replace : ContentModule, IModule

Constructors

Name Summary
Replace(string, ContextConfig) Replaces all occurrences of the search string in every input document with the string value of the returned object. This allows you to specify different content depending on the execution context.
Replace(string, DocumentConfig) Replaces all occurrences of the search string in every input document with the string value of the returned object. This allows you to specify different content for each document depending on the input document.
Replace(string, Func<Match, IDocument, Object>) Replaces all occurrences of the search string in every input document with the string value of the objects returned by the delegate. The delegate will be called for each Match in the supplied regular expression.
Replace(string, Func<Match, Object>) Replaces all occurrences of the search string in every input document with the string value of the objects returned by the delegate. The delegate will be called for each Match in the supplied regular expression.
Replace(string, IModule[]) The specified modules are executed against an empty initial document and the resulting document content replaces all occurrences of the search string in every input document (possibly creating more than one output document for each input document).
Replace(string, Object) Replaces all occurrences of the search string in every input document with the string value of the specified object.

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.
IsRegex(RegexOptions) Replace
Indicates that the search string(s) should be treated as a regular expression(s) with the specified options.
GitHub