DocumentUrlContextManager.BeginScope Method

Namespace

Kampute.DocToolkit.Routing

Assembly

Kampute.DocToolkit.dll

Definition

Creates a scoped URL context for the specified document path and model.

public DocumentUrlContext BeginScope(string directory, IDocumentModel model)

Parameters

directory string: The relative directory path of the document being rendered within the documentation structure.
model IDocumentModel: The document model being processed, or null if not applicable.

Returns

DocumentUrlContext: An DocumentUrlContext object that represents the URL context scope. When disposed, the context will be reset.

Exceptions

ArgumentException: Thrown when directory is an absolute path.