This documentation is archived and is not being maintained.

Login.DestinationPageUrl Property

Gets or sets the URL of the page displayed to the user when a login attempt is successful.

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

<ThemeableAttribute(False)> _
Public Overridable Property DestinationPageUrl As String
<asp:Login DestinationPageUrl="String" />

Property Value

Type: System.String
The URL of the page the user is redirected to when a login attempt is successful. The default is Empty.

The DestinationPageUrl property specifies the page that is displayed when a login attempt is successful.

The default behavior of the Login control is to return the user to the referring page, or to the page defined in the defaultUrl attribute of the forms element in the Web.config file.

The DestinationPageUrl property overrides the default behavior of the Login control, as well as the defaultUrl setting made in the configuration file.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins.

Walkthrough: Managing Web Site Users with RolesBuilding ASP .NET Web Applications in Visual Studio

The following code example sets the DestinationPageUrl property. The Page_Load method is used to attach the URL of the referring page to the URL of the destination page so that the destination page can return the user to the original page if desired.

<%@ Page Language="VB" autoEventWireup="false" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "">

<script runat="server">
        Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
            login1.DestinationPageUrl = _
                String.Format("terms.aspx?{0}", Request.QueryString.ToString())
        End Sub

<html xmlns="" >
    <head runat="server">
    <title>ASP.NET Example</title>
        <form id="form1" runat="server">
            <asp:Login id="Login1" runat="server" 

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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