FormsAuthentication.DefaultUrl Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the URL that the FormsAuthentication class will redirect to if no redirect URL is specified.

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

Public Shared ReadOnly Property DefaultUrl As String

Property Value

Type: System.String

The URL that the FormsAuthentication class will redirect to if no redirect URL is specified. The default is "default.aspx."

The DefaultUrl property value is set in the configuration file for an ASP.NET application by using the defaultUrl attribute of the configuration element. The DefaultUrl property is used by the RedirectFromLoginPage method if no return URL is included in the request. Similarly, the GetRedirectUrl method will return the DefaultUrl if no return URL is included in the request.

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

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

.NET Framework
Available since 2.0
Return to top
Show: