Login.DestinationPageUrl Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the URL of the page displayed to the user when a login attempt is successful.
public:
virtual property System::String ^ DestinationPageUrl { System::String ^ get(); void set(System::String ^ value); };
[System.Web.UI.Themeable(false)]
public virtual string DestinationPageUrl { get; set; }
[<System.Web.UI.Themeable(false)>]
member this.DestinationPageUrl : string with get, set
Public Overridable Property DestinationPageUrl As String
Property Value
The URL of the page the user is redirected to when a login attempt is successful. The default is Empty.
- Attributes
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.
<%@ 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 xmlns="http://www.w3.org/1999/xhtml" >
<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="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 xmlns="http://www.w3.org/1999/xhtml" >
<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>
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.