GetLink(IDocument, string, bool) Method
Gets a link for the specified document using the document destination. Note that you can optionally include the host or not depending on if you want to generate host-specific links. By default, the host is not included so that sites work the same on any server including the preview server.
Containing Type


public static string GetLink(this IDocument document, string queryAndFragment, bool includeHost = false)


Name Type Description
document IDocument The document to generate a link for.
queryAndFragment string Appends a query and/or fragment to the document path. If a value is provided for this parameter and it does not start with "?" or "#" then it will be assumed a query and a "?" will be prefixed.
includeHost bool If set to true the host configured in the output settings will be included in the link, otherwise the host will be omitted and only the root path will be included (default).

Return Value

Type Description
string A string representation of the path suitable for a web link.