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)

public virtual string DestinationPageUrl { get; set; }
/** @property */
public String get_DestinationPageUrl ()

/** @property */
public void set_DestinationPageUrl (String value)

public function get DestinationPageUrl () : String

public function set DestinationPageUrl (value : String)

Not applicable.

Property Value

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 Introduction to ASP.NET Themes.

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="C#" autoEventWireup="false" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "">

<script runat="server">
        void PageLoad(Object sender, EventArgs e)
            Login1.DestinationPageUrl = 
                String.Format("terms.aspx?{0}", Request.QueryString.ToString());

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

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0