Reads XMP data from the input documents and adds it to the document metadata.
- Namespace
- Statiq
.Xmp - Interfaces
- Base Types
-
- object
- Module
graph BT
Type-->Base0["Module"]
click Base0 "/api/Statiq.Common/Module"
Base0-->Base1["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type["ReadXmp"]
class Type type-node
Syntax
public class ReadXmp : Module, IModuleRemarks
The
Source of each input document will be used to
locate any sidecar files.
Constructors
| Name | Summary |
|---|---|
| ReadXmp |
Reads XMP data from the input documents and adds it to the document metadata with the specified options. |
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
|
| ExecuteContextAsync |
Task |
Executes the module once for all input documents.
Inherited from Module
|
| ExecuteInputAsync |
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
|
| WithMetadata |
ReadXmp |
Specifies an XML element to find in the XMP data along with the metadata key that will be used to set it in the document.
|
| WithNamespace |
ReadXmp |
Adds or overrides a namespace for resolving namespace prefixes of the
xmpPath
specified in WithMetadata(string, string, bool). Several default namespaces are predefined:
|