EscapeHtml Class
Automatically escapes HTML content.
Namespace
Statiq.Core
Interfaces
Base Types
graph BT Type-->Base0["ParallelModule"] click Base0 "/api/Statiq.Common/ParallelModule" Base0-->Base1["Module"] click Base1 "/api/Statiq.Common/Module" Base1-->Base2["object"] Type-.->Interface0["IModule"] click Interface0 "/api/Statiq.Common/IModule" Type-.->Interface1["IParallelModule"] click Interface1 "/api/Statiq.Common/IParallelModule" Type["EscapeHtml"] class Type type-node

Syntax

public class EscapeHtml : ParallelModule, IModule, IParallelModule

Constructors

Name Summary
EscapeHtml() Escapes HTML content with predefined escape sequences.

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
EscapeAllNonstandard() EscapeHtml
Escapes all nonstandard characters (standard characters are defined with the WithDefaultStandard() or WithStandard() methods).
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
WithDefaultStandard() EscapeHtml
Defines a standard set of characters as 0-9, a-z, A-Z, newlines, and space. Use with the EscapeAllNonstandard() method to whitelist this default set of characters.
WithEscapedChar(char[]) EscapeHtml
Defines additional characters to escape.
WithStandard(char[]) EscapeHtml
Defines a custom set of standard characters to use with the EscapeAllNonstandard() method.

Extension Methods