FormsAuthentication.LoginUrl Property (System.Web.Security)

.NET Framework Class Library

FormsAuthentication..::.LoginUrl Property

Gets the URL for the login page that the FormsAuthentication class will redirect to.

Namespace: System.Web.Security
Assembly: System.Web (in System.Web.dll)

Syntax

Visual Basic (Declaration)

Public Shared ReadOnly Property LoginUrl As String

Visual Basic (Usage)

Dim value As String

value = FormsAuthentication.LoginUrl

public static string LoginUrl { get; }

Visual C++

public:
static property String^ LoginUrl {
    String^ get ();
}

JScript

public static function get LoginUrl () : String

Property Value

Type: System..::.String
The URL for the login page that the FormsAuthentication class will redirect to. The default is "login.aspx."

Remarks

The LoginUrl property value is set in the configuration file for an ASP.NET application by using the loginUrl attribute of the forms configuration element. The LoginUrl is used by the RedirectToLoginPage method.

Examples

The following code example sets the loginUrl attribute in the Web.config file.

<authentication mode="Forms">
  <forms loginUrl="member_login.aspx"
    defaultUrl="index.aspx" />
</authentication>

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

FormsAuthentication Class

FormsAuthentication Members

System.Web.Security Namespace

Other Resources

ASP.NET Web Application Security