UrlHelperPreviewExtensions.AuthenticateUrl Method (ExtensionPoint<UrlHelper>, String, Boolean)

Extends the given url by additional authentication information when the current request carries authentication information in the request URL.

Namespace: Kentico.Content.Web.Mvc
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 12.0.0

Syntax

public static HtmlString AuthenticateUrl(
	this ExtensionPoint<UrlHelper> instance,
	string url,
	bool readonlyMode
)

Parameters

instance

Type: Kentico.Web.Mvc.ExtensionPoint<UrlHelper>
HtmlHelper extension point.

url

Type: System.String
URL that is to be authenticated. The following URL formats will be authenticated: Relative (virtual) or absolute path. Query string parameters are not secured and can be changed even after the url is authenticated.

readonlyMode

Type: System.Boolean
Indicates if readonly mode should be enabled to disallow modify actions and POST requests.

Return Value

Type: HtmlString
If the current request carries authentication information in the URL, returns the given url extended by authentication information. If the current request does not carry authentication information in the URL, returns the original url.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ExtensionPoint<UrlHelper>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	instance is null.
ArgumentException	url is null or empty.