ReadXmp Class
Reads XMP data from the input documents and adds it to the document metadata.
Namespace
Statiq.Xmp
Interfaces
Base Types
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, IModule

Remarks

The Source of each input document will be used to locate any sidecar files.

Constructors

Name Summary
ReadXmp(bool, bool, bool, bool) Reads XMP data from the input documents and adds it to the document metadata with the specified options.

Methods

Name Return Value Summary
AfterExecution(IExecutionContext, ExecutionOutputs) void
Called after each module execution.
Inherited from Module
AfterExecutionAsync(IExecutionContext, ExecutionOutputs) Task
Called after each module execution.
Inherited from Module
BeforeExecution(IExecutionContext) void
Called before each module execution.
Inherited from Module
BeforeExecutionAsync(IExecutionContext) Task
Called before each module execution.
Inherited from Module
ExecuteAsync(IExecutionContext) Task<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 Module
ExecuteContextAsync(IExecutionContext) Task<IEnumerable<IDocument>>
Executes the module once for all input documents.
Inherited from Module
ExecuteInputAsync(IDocument, IExecutionContext) Task<IEnumerable<IDocument>>
Finally(IExecutionContext) void
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
FinallyAsync(IExecutionContext) Task
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
WithMetadata(string, string, bool) 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(string, string) ReadXmp
Adds or overrides a namespace for resolving namespace prefixes of the xmpPath specified in WithMetadata(string, string, bool). Several default namespaces are predefined:
  • dc - http://purl.org/dc/elements/1.1/
  • xmpRights - http://ns.adobe.com/xap/1.0/rights/
  • cc - http://creativecommons.org/ns#
  • xmp - http://ns.adobe.com/xap/1.0/
  • xml - http://www.w3.org/XML/1998/namespace

Extension Methods