DocumentationUrlTransformer Class

Namespace
Kampute.DocToolkit.Routing
Assembly
  • Kampute.DocToolkit.dll

Definition

Resolves documentation references according to their URL scope and the current document context.
public class DocumentationUrlTransformer : IUrlTransformer
Inheritance
  • object
  • DocumentationUrlTransformer
Implements

Remarks

This class implements the IUrlTransformer interface and is designed to work with a specific documentation context. Documentation-root-relative URLs use the ~/ marker. Site-root-relative URLs beginning with / and ordinary document-relative URLs retain their standard URL meaning.

Constructors

DocumentationUrlTransformer(IDocumentationContext)Initializes a new instance of the DocumentationUrlTransformer class.

Properties

ContextGets the documentation context used for transforming URLs.
MayTransformUrlsGets a value indicating whether the URLs need to be transformed based on the current context and the active URL context.

Methods

TryTransformUrl(string, out Uri)Attempts to transform a URL string into an absolute or document-relative URL.

See Also