IUrlHelper.IsLocalUrl(String) Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc

Assembly:: Microsoft.AspNetCore.Mvc.Abstractions.dll

Package:: Microsoft.AspNetCore.Mvc.Abstractions v1.0.0

Package:: Microsoft.AspNetCore.Mvc.Abstractions v1.1.0

Package:: Microsoft.AspNetCore.Mvc.Abstractions v2.0.0

Package:: Microsoft.AspNetCore.Mvc.Abstractions v2.1.0

Package:: Microsoft.AspNetCore.Mvc.Abstractions v2.2.0

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Package:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Source:: IUrlHelper.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a value that indicates whether the URL is local. A URL is considered local if it does not have a host / authority part and it has an absolute path. URLs using virtual paths ('~/') are also local.

public:
 bool IsLocalUrl(System::String ^ url);

public bool IsLocalUrl (string url);

public bool IsLocalUrl (string? url);

abstract member IsLocalUrl : string -> bool

Public Function IsLocalUrl (url As String) As Boolean

Parameters

url: String

The URL.

Returns

Boolean

true if the URL is local; otherwise, false.

Examples

For example, the following URLs are considered local:

/Views/Default/Index.html
~/Index.html

The following URLs are non-local:

../Index.html
http://www.contoso.com/
http://localhost/Index.html

Applies to

Share via