Creates new documents.
- Namespace
- Statiq
.Core - Interfaces
- Base Types
-
- object
- Module
- ConfigModule
<IEnumerable <IDocument> >
graph BT
Type-->Base0["ConfigModule<IEnumerable<IDocument>>"]
Base0-->Base1["Module"]
click Base1 "/api/Statiq.Common/Module"
Base1-->Base2["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type["CreateDocuments"]
class Type type-node
Syntax
public class CreateDocuments : ConfigModule<IEnumerable<IDocument>>, IModuleRemarks
This module does not include the input documents as part of it's output
(if you need to change the content of an existing document, use
SetContent).
Constructors
| Name | Summary |
|---|---|
| CreateDocuments |
Creates new documents with the specified content. |
| CreateDocuments |
Creates a new document with the specified content. |
| CreateDocuments |
Creates new documents with the specified metadata. |
| CreateDocuments |
Creates new documents with the specified metadata. |
| CreateDocuments |
Creates new documents with the specified content. |
| CreateDocuments |
Creates new documents with the specified content and metadata. |
| CreateDocuments |
Creates a specified number of new empty documents. |
| CreateDocuments |
Creates new documents with the specified content. |
| CreateDocuments |
Creates new documents with the specified content and metadata. |
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 |
|
| 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
|