UrlHelperFileExtensions.FileUrl Method

Note: This API is now obsolete.

Generates a fully qualified URL to the specified file path.

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

Syntax

[ObsoleteAttribute("Use IFileUrl.WithOptions() instead to parametrize the path.")]
public static string FileUrl(
	this UrlHelperExtensionPoint instance,
	string path,
	FileUrlOptions options
)

Parameters

instance

Type: Kentico.Web.Mvc.UrlHelperExtensionPoint
The object that provides methods to build URLs to Kentico content.

path

Type: System.String
The virtual path of the file.

options

Type: Kentico.Content.Web.Mvc.FileUrlOptions
Options that affect the file URL.

Return Value

Type: String
The fully qualified URL to the file.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type UrlHelperExtensionPoint. 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	path is null, empty or contains query string parameters.