Class SourceAnnotationDocumentModifierDecorator

Implementation of IModifiesDocument which adds source annotation to the document DOM where appropriate. Source annotation is a debugging and logging aid which helps developers see where each part of the output DOM originates.

Inheritance
System.Object
SourceAnnotationDocumentModifierDecorator
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: ZptSharp.Rendering
Assembly: ZptSharp.dll
Syntax
public class SourceAnnotationDocumentModifierDecorator : IModifiesDocument

Constructors

| Improve this Doc View Source

SourceAnnotationDocumentModifierDecorator(IGetsSourceAnnotationContextProcessor, IIterativelyModifiesDocument, RenderingConfig, IModifiesDocument, IGetsRootExpressionContext)

Initializes a new instance of the SourceAnnotationDocumentModifierDecorator class.

Declaration
public SourceAnnotationDocumentModifierDecorator(IGetsSourceAnnotationContextProcessor contextProcessorFactory, IIterativelyModifiesDocument iterativeModifier, RenderingConfig config, IModifiesDocument wrapped, IGetsRootExpressionContext rootContextProvider)
Parameters
Type Name Description
IGetsSourceAnnotationContextProcessor contextProcessorFactory

Context processor factory.
IIterativelyModifiesDocument iterativeModifier

Iterative modifier.
RenderingConfig config

Rendering config.
IModifiesDocument wrapped

Wrapped.
IGetsRootExpressionContext rootContextProvider

A provider for the root expression context.

Methods

| Improve this Doc View Source

ModifyDocumentAsync(IDocument, Object, CancellationToken)

Performs alterations for a specified document, using the specified rendering request. This method will manipulate the document, according to the rules of ZPT.

Declaration
public Task ModifyDocumentAsync(IDocument document, object model, CancellationToken token = default(CancellationToken))
Parameters
Type Name Description
IDocument document

The document to render.
System.Object model

The model to render.
System.Threading.CancellationToken token

An object used to cancel the operation if required.
Returns
Type Description
System.Threading.Tasks.Task

A task indicating when the process is complete.

Implements