Splits a sequence of documents into multiple pages.
- Namespace
- Statiq
.Core - Interfaces
- Base Types
-
- object
- Module
- SyncModule
graph BT
Type-->Base0["SyncModule"]
click Base0 "/api/Statiq.Common/SyncModule"
Base0-->Base1["Module"]
click Base1 "/api/Statiq.Common/Module"
Base1-->Base2["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type["PaginateDocuments"]
class Type type-node
Syntax
public class PaginateDocuments : SyncModule, IModuleRemarks
This module forms pages from the input documents.
Note that if there are no documents to paginate, this module will still
output an empty page without any documents inside the page.
Constructors
| Name | Summary |
|---|---|
| PaginateDocuments |
Partitions the result of the input documents into the specified number of pages. |
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
|
| ExecuteContext |
IEnumerable |
Executes the module once for all input documents.
|
| ExecuteContextAsync |
Task |
Executes the module once for all input documents.
Inherited from SyncModule
|
| ExecuteInput |
IEnumerable |
Executes the module.
Inherited from SyncModule
|
| ExecuteInputAsync |
Task |
Executes the module.
Inherited from SyncModule
|
| 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
|
| SkipPages |
PaginateDocuments |
Skips a specified number of pages before outputting pages.
|
| TakePages |
PaginateDocuments |
Only outputs a specific number of pages.
|
| WithSource |
PaginateDocuments |
Sets the source (and destination) of the output document(s).
|