Trace Class

Summary

Outputs trace messages during execution.
Assembly
Wyam.Core.dll
Namespace
Wyam.Core.Modules.Extensibility
Interfaces
Base Types
graph BT Type-->Base0["ContentModule"] click Base0 "/api/Wyam.Common.Modules/ContentModule" Base0-->Base1["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type["Trace"] class Type type-node

Syntax

public class Trace : ContentModule, IModule

Remarks

This module has no effect on documents and the input documents are passed through to output documents.

Constructors

Name Summary
Trace(ContextConfig) Outputs the string value of the returned object to trace. This allows you to trace different content depending on the execution context.
Trace(DocumentConfig) Outputs the string value of the returned object to trace. This allows you to trace different content for each document depending on the input document.
Trace(IModule[]) The specified modules are executed against an empty initial document and the resulting document content is output to trace.
Trace(Object) Outputs the string value of the specified object to trace.

Methods

Name Value Summary
EventType(TraceEventType) Trace
Sets the event type to trace.
Execute(IReadOnlyList<IDocument>, IExecutionContext) 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 ContentModule
Execute(Object, IDocument, IExecutionContext) IEnumerable<IDocument>
Executes the module with the specified content against a single document. Note that content can be passed in as null, implementers should guard against that.
GitHub