XSLT Extensions: Urls

Activation

Enabling the XSLT extension for use in your XSLT templates. Add the following XML snippet to your ~/config/xsltExtensions.config file:

<XsltExtensions>
	...
	<ext assembly="uComponents.XsltExtensions" type="uComponents.XsltExtensions.Urls" alias="ucomponents.urls" />
	...
</XsltExtensions>

Methods

Here are available methods in the Urls library:

• AddAltTemplate
• AppendOrUpdateQueryString
• FormatUrl
• GetHostName
• GetNodeIdByUrl
• GetTextByUrl
• GetXmlNodeByUrl
• GuessNiceUrl
• NiceUrl

Events

Here are available events in the Urls library:

• OnBeforeNiceUrlGenerated
• OnAfterNiceUrlGenerated

AddAltTemplate

Appends the alternative template to the url as a querystring or folder instead of a querystring. Is “use directory urls” aware if set. Returns: Complete url with alt template merged in.

Parameters

| Name | Type | Notes | |——|——|——-| | url | System.String | | | altTemplateAlias | System.String | | | useQueryString | System.Boolean | (optional - defaults to false) | | useDirectoryUrls | System.Boolean | (optional - defaults to GlobalSettings.UseDirectoryUrls) |

XSLT Example

<xsl:value-of select="ucomponents.urls:AddAltTemplate(umbraco.library:NiceUrl($currentPage/@id), 'rss', false())" />

AppendOrUpdateQueryString

Appends or updates a query string value to supplied Url Returns: The updated Url

Parameters

| Name | Type | Notes | |——|——|——-| | url | System.String | (optional - defaults to Request.RawUrl) | | key | System.String | | | value | System.String | |

XSLT Example

<xsl:value-of select="ucomponents.urls:AppendOrUpdateQueryString(umbraco.library:NiceUrl($currentPage/@id), 'page', '2')" />

FormatUrl

Formats the URL - replacing characters in the string to make a ‘safe’ URL. Returns: Returns a ‘safe’ URL, removing illegal characters.

Parameters

| Name | Type | Notes | |——|——|——-| | input | System.String | |

XSLT Example

<xsl:value-of select="ucomponents.urls:FormatUrl($currentPage/@nodeName)" />

NiceUrl

Returns a nicely formatted Url for a given node and alternative template. Returns: The NiceUrl for the node id.

This method triggers the OnBeforeNiceUrlGenerated andOnAfterNiceUrlGenerated events.

Parameters

| Name | Type | Notes | |——|——|——-| | nodeId | System.Int32 | | | altTemplateAlias | System.String | (optional - defaults to null) | | useQueryString | System.Boolean | (optional - defaults to false) |

XSLT Example

<xsl:value-of select="ucomponents.urls:NiceUrl($currentPage/@id, 'rss', false())" />

GetHostName

Gets the hostname of the node Id. Returns: Returns the hostname for the node Id.

Parameters

| Name | Type | Notes | |——|——|——-| | nodeId | System.Int32 | |

XSLT Example

<xsl:value-of select="ucomponents.urls:GetHostName($currentPage/@id)" />

GetNodeIdByUrl

Obsolete: Please use ucomponents.nodes:GetNodeIdByUrl.

GetTextByUrl

Gets the text by URL. Returns: Returns the text (System.String) from a given URL.

Parameters

| Name | Type | Notes | |——|——|——-| | url | System.String | |

XSLT Example

<xsl:value-of select="ucomponents.urls:GetTextByUrl('http://ucomponents.github.io/LICENSE')" />

GetXmlNodeByUrl

Obsolete: Please use ucomponents.nodes:GetXmlNodeByUrl.

GuessNiceUrl

Guesses the NiceUrl based on the node id. Returns: Returns a guestimate of the NiceUrl for a node id.

GuessNiceUrl is not very performant when attempting to guess the URL for unpublished nodes. Do not over-use this method. It makes many database calls and will be slow!

Parameters

| Name | Type | Notes | |——|——|——-| | nodeId | System.Int32 | |

XSLT Example

<xsl:value-of select="ucomponents.urls:GuessNiceUrl(1066)" />

OnBeforeNiceUrlGenerated

Dispatches a BeforeNiceUrlGenerated event.

Parameters

| Name | Type | Notes | |——|——|——-| | nodeId | System.Int32 | |

C# Example

uComponents.XsltExtensions.Urls.BeforeNiceUrlGenerated += Urls_BeforeNiceUrlGenerated;

OnAfterNiceUrlGenerated

Dispatches an AfterNiceUrlGenerated event.

Parameters

| Name | Type | Notes | |——|——|——-| | nodeId | System.Int32 | | | url | System.String | |

C# Example

uComponents.XsltExtensions.Urls.AfterNiceUrlGenerated += Urls_AfterNiceUrlGenerated;