UrlContextAwareWriter Class

Namespace
Kampute.DocToolkit.IO.Writers
Assembly
  • Kampute.DocToolkit.dll

Definition

Represents a text writer for rendering documentation content.
public class UrlContextAwareWriter : WrappedTextWriter
Inheritance

Remarks

The UrlContextAwareWriter class serves as a text writer for rendering documentation content, which includes handling URL adjustments for cross-document links and managing the output stream.

When working with UrlContextAwareWriter instances, note that they must be properly disposed after use to ensure all resources are released correctly and state is reset for subsequent rendering tasks.

Thread Safety

Public static members of the type are guaranteed to be thread-safe. However, public instance members are not thread-safe.

Constructors

UrlContextAwareWriter(TextWriter, DocumentUrlContext)Initializes a new instance of the UrlContextAwareWriter class.

Properties

UrlContextGets the DocumentUrlContext that provides URL adjustment for the document being rendered.

Methods

Dispose(bool)Disposes the current instance of UrlContextAwareWriter and releases any resources it holds.