Click here to Skip to main content
11,415,164 members (70,656 online)
Click here to Skip to main content

How to Redirect to Another Page when Session Timeout in ASP.NET (when pages contain Ajax UpdatePanel)

, 18 Jun 2008 CPOL
Rate this:
Please Sign up or sign in to vote.
A small solution to deal with session timeout when using Ajax UpdatePanel

Introduction

Session timeout in ASP.NET is such an important problem with web developer. When session ends, we run into some exceptional situations. There are also many solutions to deal with this problem on the Internet. But few of them have discussed about redirecting to another page when there is session timeout, especially when we work with Ajax UpdatePanel.

So, I suggest a way to do this.

Solution

My main idea is: 3 minutes before session is gone, we will alert the user to save his/her data or make any postbacks. If user still does not do anything, then 5 milliseconds before session goes, we will redirect the page to Login.aspx (or just refresh page by redirecting to itself).

Using the Code

Add the following code to your Master page:

private void CheckSessionTimeout()
{
    string msgSession = 'Warning: Within next 3 minutes, if you do not do anything, '+
               ' our system will redirect to the login page. Please save changed data.';
    //time to remind, 3 minutes before session ends
    int int_MilliSecondsTimeReminder = (this.Session.Timeout * 60000) - 3 * 60000; 
    //time to redirect, 5 milliseconds before session ends
    int int_MilliSecondsTimeOut = (this.Session.Timeout * 60000) - 5; 

    string str_Script = @"
            var myTimeReminder, myTimeOut; 
            clearTimeout(myTimeReminder); 
            clearTimeout(myTimeOut); " +
            "var sessionTimeReminder = " + 
		int_MilliSecondsTimeReminder.ToString() + "; " +
            "var sessionTimeout = " + int_MilliSecondsTimeOut.ToString() + ";" +
            "function doReminder(){ alert('" + msgSession + "'); }" +
            "function doRedirect(){ window.location.href="/KB/session/login.aspx"; }" + @"
            myTimeReminder=setTimeout('doReminder()', sessionTimeReminder); 
            myTimeOut=setTimeout('doRedirect()', sessionTimeout); ";

     ScriptManager.RegisterClientScriptBlock(this.Page, this.GetType(), 
           "CheckSessionOut", str_Script, true);
}
private void Page_Load(object sender, System.EventArgs e)
{
    this.CheckSessionTimeout();
}

If you do not want to redirect to login page, you can just refresh the page by replacing it by this code:

function doRedirect(){ window.location.href=window.location.href; }

If you do not use ScriptManager, you can replace with Page.RegisterClientScriptBlock(...)

Hope this helps.

History

  • 18th June, 2008: Initial post 

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Nguyen Quy Minh
Chief Technology Officer
Vietnam Vietnam
MCSD, MSc
http://www.sirvina.com

Comments and Discussions

 
QuestionGreat solution, you are genius Nguyen [modified] Pin
Member 26560432-May-14 8:33
memberMember 26560432-May-14 8:33 
Questionsession Pin
aashish tyagi2-Apr-14 21:47
memberaashish tyagi2-Apr-14 21:47 
QuestionHelp Pin
charmax12-Dec-12 12:03
membercharmax12-Dec-12 12:03 
GeneralMy vote of 5 Pin
ChandraShekar.SK7-Aug-12 5:41
memberChandraShekar.SK7-Aug-12 5:41 
QuestionYour code is simple and works nicely - I adapted to VB.NET and used on the site's Master Page Pin
jacklennon10-Feb-12 6:19
memberjacklennon10-Feb-12 6:19 
GeneralMy vote of 5 Pin
jacklennon10-Feb-12 6:10
memberjacklennon10-Feb-12 6:10 
QuestionExcellente article! Thanks Pin
Bruno Lemos27-Oct-11 7:23
memberBruno Lemos27-Oct-11 7:23 
GeneralMy vote of 5 Pin
digjam94229-Mar-11 21:36
memberdigjam94229-Mar-11 21:36 
Generallogin.aspx Pin
Ajay Kale New27-Sep-10 1:17
memberAjay Kale New27-Sep-10 1:17 
Generalre automatic redirection to Login.aspx Pin
Ajay Kale New9-Sep-10 3:34
memberAjay Kale New9-Sep-10 3:34 
Questionhow to create secured login page Pin
appusri53874-Nov-09 2:56
memberappusri53874-Nov-09 2:56 
QuestionHow to add session renew state to the alert box? Pin
Robert H.12-Aug-08 8:59
memberRobert H.12-Aug-08 8:59 
AnswerRe: How to add session renew state to the alert box? Pin
Nguyen Quy Minh12-Aug-08 21:28
memberNguyen Quy Minh12-Aug-08 21:28 
GeneralRe: How to add session renew state to the alert box? Pin
Robert H.13-Aug-08 10:31
memberRobert H.13-Aug-08 10:31 
GeneralRe: How to add session renew state to the alert box? Pin
Nguyen Quy Minh13-Aug-08 20:07
memberNguyen Quy Minh13-Aug-08 20:07 
GeneralRe: How to add session renew state to the alert box? Pin
Robert H.14-Aug-08 6:37
memberRobert H.14-Aug-08 6:37 
GeneralRe: How to add session renew state to the alert box? Pin
rcarroll14-Jan-09 11:20
memberrcarroll14-Jan-09 11:20 
GeneralRe: How to add session renew state to the alert box? Pin
ksalvage15-Jan-09 4:52
memberksalvage15-Jan-09 4:52 
The alert box is a modal dialog in the browser so it could well be that the thread that the timer is running in is suspended while the alert is being displayed. I'm not sure how browsers treat timers running in the main context, or how the threading model works internally. A better solution would be to create a div that is hidden and show it when the time runs out.

I use the following code in my master page head:
<script language="javascript" type="text/javascript">
        function doRefresh(){ javascript:__doPostBack(''); }//window.location.href=window.location.href; }

        function doRedirect(){ window.location.href='login.aspx'; }
        
        function getStyleObject(objectId) {
            // checkW3C DOM, then MSIE 4, then NN 4.          
            if(document.getElementById && document.getElementById(objectId))             
	            return document.getElementById(objectId).style;            
            else if (document.all && document.all(objectId)) 
	            return document.all(objectId).style;            
            else if (document.layers && document.layers[objectId])  
	            return document.layers[objectId];            
            else             
	            return false;            
        }
 
        function setObjectVisibility(objectId, newVisibility) {            
            var styleObject = getStyleObject(objectId);                        
            if (styleObject) 
            {
	            styleObject.visibility = newVisibility;
	            return true;
            } 
            else             
	            return false;            
        }
 
        function showUserMessage()
        {
            setObjectVisibility("userMessage","visible");
        }
        
        function hideUserMessage()
        {
            setObjectVisibility("userMessage","hidden");
        }
</script>
with a div that looks like this
<div id="userMessage" style="position: absolute; background-color: white; z-index: 1; 
                        display: block; top: 5px; left: 20px; visibility:hidden; border: 1px solid black;">
                        <table width="400" style="width: 200px; height: auto; 
                            background-color:white;">
                            <tr>
                                <td>
                                    Warning: Within next 3 minutes, if you do not do anything, the system will redirect
                                    to the login page. Please save changed data.
                                </td>
                            </tr>
                            <tr>
                                <td align="right"><asp:Button CssClass="groupButton" ID="btnStillHere" OnClientClick="doRefresh()" Text="OK" runat="server" /></td>
                            </tr>
                        </table>                      
                    </div>
and this in my code behind:
    protected void Page_Load(object sender, EventArgs e)
    {
        CheckSessionTimeout();
    }
 
    private void CheckSessionTimeout()
    {
        //time to remind, 3 minutes before session end
        int int_MilliSecondsTimeReminder = (Session.Timeout * 60000) - 3 * 60000;
        //time to redirect, 5 miliseconds before session end
        int int_MilliSecondsTimeOut = (Session.Timeout * 60000) - 5;
 
        StringBuilder sb = new StringBuilder();
        sb.AppendLine("<script language="\"javascript\"" type="\"text/javascript\"">");
        sb.AppendLine("var myTimeReminder, myTimeOut;");
        sb.AppendLine("clearTimeout(myTimeReminder);");
        sb.AppendLine("clearTimeout(myTimeOut);");
        sb.AppendFormat("var sessionTimeReminder = {0};\n", int_MilliSecondsTimeReminder);
        sb.AppendFormat("var sessionTimeout = {0};\n", int_MilliSecondsTimeOut);
        sb.AppendLine("myTimeReminder=setTimeout('showUserMessage()', sessionTimeReminder);");
        sb.AppendLine("myTimeOut=setTimeout('doRedirect()', sessionTimeout);");
        sb.AppendLine("</script>");
        Page.RegisterClientScriptBlock("CheckSessionOut", sb.ToString());
 
    }

This works well for me

Life is a game. Play to win

GeneralRe: How to add session renew state to the alert box? Pin
Nguyen Quy Minh16-Jan-09 18:54
memberNguyen Quy Minh16-Jan-09 18:54 
QuestionWorks fine but confirm box comes even when I am working on screen Pin
chaggu9-Jul-08 13:03
memberchaggu9-Jul-08 13:03 
AnswerRe: Works fine but confirm box comes even when I am working on screen Pin
Nguyen Quy Minh10-Jul-08 0:25
memberNguyen Quy Minh10-Jul-08 0:25 
QuestionRe: Works fine but confirm box comes even when I am working on screen Pin
chaggu10-Jul-08 4:22
memberchaggu10-Jul-08 4:22 
AnswerRe: Works fine but confirm box comes even when I am working on screen Pin
Nguyen Quy Minh11-Jul-08 7:12
memberNguyen Quy Minh11-Jul-08 7:12 
GeneralRe: Works fine but confirm box comes even when I am working on screen Pin
chaggu24-Jul-08 5:19
memberchaggu24-Jul-08 5:19 
GeneralMany thanks Pin
tndang4-Jul-08 4:14
membertndang4-Jul-08 4:14 
GeneralNo effect when something happened in update panel. Pin
StressBall3-Jul-08 1:23
memberStressBall3-Jul-08 1:23 
GeneralRe: No effect when something happened in update panel. Pin
Nguyen Quy Minh3-Jul-08 7:03
memberNguyen Quy Minh3-Jul-08 7:03 
GeneralRe: No effect when something happened in update panel. Pin
StressBall3-Jul-08 17:49
memberStressBall3-Jul-08 17:49 
GeneralRe: No effect when something happened in update panel. Pin
Nguyen Quy Minh4-Jul-08 4:04
memberNguyen Quy Minh4-Jul-08 4:04 
GeneralRe: No effect when something happened in update panel. Pin
anukit24-Sep-08 4:48
memberanukit24-Sep-08 4:48 
GeneralSome more improvements... Pin
Tuomas Hietanen27-Jun-08 6:38
memberTuomas Hietanen27-Jun-08 6:38 
GeneralRe: Some more improvements... Pin
Nguyen Quy Minh27-Jun-08 8:22
memberNguyen Quy Minh27-Jun-08 8:22 
Generalthanks! Pin
vegeta4ss25-Jun-08 5:17
membervegeta4ss25-Jun-08 5:17 
QuestionWhat if javascript is disabled? Pin
evolved19-Jun-08 9:04
memberevolved19-Jun-08 9:04 
AnswerRe: What if javascript is disabled? Pin
Nguyen Quy Minh19-Jun-08 22:48
memberNguyen Quy Minh19-Jun-08 22:48 
QuestionWhat about inheritante? Or Forms authentication? Pin
tkrafael_net19-Jun-08 7:04
membertkrafael_net19-Jun-08 7:04 
AnswerRe: What about inheritante? Or Forms authentication? Pin
Nguyen Quy Minh19-Jun-08 8:56
memberNguyen Quy Minh19-Jun-08 8:56 
AnswerRe: What about inheritante? Or Forms authentication? Pin
George Peters2-Jul-08 4:40
memberGeorge Peters2-Jul-08 4:40 
GeneralRe: What about inheritante? Or Forms authentication? Pin
tkrafael_net2-Jul-08 14:27
membertkrafael_net2-Jul-08 14:27 
GeneralRe: What about inheritante? Or Forms authentication? Pin
Nguyen Quy Minh3-Jul-08 7:00
memberNguyen Quy Minh3-Jul-08 7:00 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.150427.4 | Last Updated 18 Jun 2008
Article Copyright 2008 by Nguyen Quy Minh
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid