UrlReference.TargetUrl Property

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

Definition

Gets the URL corresponding to the SourceUrl in the generated documentation.
public Uri TargetUrl { get; }

Property Value

Uri
A Uri representing the target URL, or null if the URL could not be resolved.

Remarks

If the SourceUrl could not be resolved to a URL of an internal resource, this property will be null. Common reasons for a null value include:
  • The source string is not a well-formed absolute or relative URI.
  • The source contains only a fragment identifier or only a query string with no path to resolve.
  • The source points to a URL outside the scope of the documentation set.
When the TargetUrl is a relative URL, it is relative to the directory of the referencing model's documentation page as indicated by the BaseDirectory property.

A non-nullTargetUrl indicates a resolved URL, but it does not guarantee that the URL points to an existing resource within the documentation. This is because the target resource may not have been generated yet or might not be included in the documentation set at the time of URL resolution.