Login.DestinationPageUrl Property (System.Web.UI.WebControls)

DestinationPageUrl Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

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)

Syntax

Visual Basic (Declaration)

<ThemeableAttribute(False)> _
Public Overridable Property DestinationPageUrl As String

Visual Basic (Usage)

Dim instance As Login
Dim value As String

value = instance.DestinationPageUrl

instance.DestinationPageUrl = value

[ThemeableAttribute(false)]
public virtual string DestinationPageUrl { get; set; }

Visual C++

[ThemeableAttribute(false)]
public:
virtual property String^ DestinationPageUrl {
    String^ get ();
    void set (String^ value);
}

JScript

public function get DestinationPageUrl () : String
public function set DestinationPageUrl (value : String)

ASP.NET

<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.

Remarks

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 Overview.

Topic	Location
Walkthrough: Managing Web Site Users with Roles	Building ASP .NET Web Applications in Visual Studio
Walkthrough: Managing Web Site Users with Roles	Building Applications with Visual Web Developer
Walkthrough: Managing Web Site Users with Roles	Building ASP .NET Web Applications in Visual Studio

Examples

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.

Visual Basic

<%@ Page Language="VB" autoEventWireup="false" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<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
</script>

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

<%@ Page Language="C#" autoEventWireup="false" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

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

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

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

System.Web.UI.WebControls Namespace

Other Resources

ASP.NET Login Controls Overview

forms Element for authentication (ASP.NET Settings Schema)