Queries HTML content of the input documents and modifies the elements that match a query selector.

Namespace

Interfaces

Base Types

Syntax

public class ProcessHtml : ParallelModule, IModule, IParallelModule

Remarks

Note that because this module parses the document content as standards-compliant HTML and outputs the formatted post-parsed DOM, you should only place this module after all other template processing has been performed.

Constructors

Name	Summary
ProcessHtml(string, Action<IDocument, IExecutionContext, IElement, Dictionary<string, object>>)	Creates the module with the specified query selector and processing function.
ProcessHtml(string, Action<IDocument, IExecutionContext, IElement>)	Creates the module with the specified query selector and processing function.
ProcessHtml(string, Action<IElement, Dictionary<string, object>>)	Creates the module with the specified query selector and processing function.
ProcessHtml(string, Action<IElement>)	Creates the module with the specified query selector and processing function.

Properties

Name	Property Type	Summary
Parallel	bool	Indicates whether documents will be processed by this module in parallel. Inherited from ParallelModule

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 ParallelModule
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
First(bool)	ProcessHtml	Specifies that only the first query result should be processed (the default is `false`).

Extension Methods

Name	Value	Summary
ForEachDocument()	ForEachDocument	From IModuleExtensions
ThrowIfNull<ProcessHtml>(string)	T	From GuardExtensions
ToDocument<ProcessHtml>(IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ProcessHtml>(IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ProcessHtml>(NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ProcessHtml>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ProcessHtml>(NormalizedPath, NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ProcessHtml>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
WithParallelExecution<ProcessHtml>(bool)	TModule	Indicates that the module should process documents in parallel. From IParallelModuleExtensions