Replaces a search string in the specified content with the content of input documents.
- Namespace
- Statiq
.Core - Interfaces
- Base Types
-
- object
- Module
- ParallelConfigModule
<string>
graph BT
Type-->Base0["ParallelConfigModule<string>"]
Base0-->Base1["Module"]
click Base1 "/api/Statiq.Common/Module"
Base1-->Base2["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type-.->Interface1["IParallelModule"]
click Interface1 "/api/Statiq.Common/IParallelModule"
Type["ReplaceWithContent"]
class Type type-node
Syntax
public class ReplaceWithContent : ParallelConfigModule<string>, IModule, IParallelModuleRemarks
This is sort of like the inverse of the Replace module and is very useful for simple
template substitution.
Constructors
| Name | Summary |
|---|---|
| ReplaceWithContent |
Replaces all occurrences of the search string in the string value of the returned object with the content of each input document. This allows you to specify different content for each document depending on the input document. |
Methods
| Name | Return Value | Summary |
|---|---|---|
| AfterExecution |
void |
Called after each module execution.
Inherited from Module
|
| AfterExecutionAsync |
Task |
Called after each module execution.
Inherited from Module
|
| BeforeExecution |
void |
Called before each module execution.
Inherited from Module
|
| BeforeExecutionAsync |
Task |
Called before each module execution.
Inherited from Module
|
| ExecuteAsync |
Task |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
|
| ExecuteConfigAsync |
Task |
Executes the module for each input document in parallel.
If there aren't any input documents and the config delegate doesn't require documents,
this will be called once with a null input.
|
| Finally |
void |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| FinallyAsync |
Task |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| IsRegex |
ReplaceWithContent |
Indicates that the search string(s) should be treated as a regular expression(s)
with the specified options.
|