|
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||
|
Announcements
Services
Chapters
Feature Zones
|
Note: This is an unedited contribution. If this article is inappropriate,
needs attention or copies someone else's work without reference then please
Report This Article
Contents
Introduction IntroductionIn my previous article I explained in detail the ASP.NET request processing architecture. If you recall, the article traced a request for an ASP.NET page from the moment it is issued from the browser until it reached the HTTP Handler. So what happens next? The answer is the ASP.NET page life cycle starts… In this article I will discuss in detail the ASP.NET page life cycle and the ASP.NET Viewstate as an integrated unit. It is strongly recommended that you read the complete article; however, if –and only if – you consider yourself very familiar with the inner workings of Viewstate and the page life cycle and you want to go directly to the “cream” of the advanced scenarios then you skip your way through to the “Viewstate Walkthroughs” section. Introducing Viewstate outside ASP.NET ContextIn its very basic form, Viewstate is nothing more than a property which has key/value pair indexer:
Viewstate[“mystringvariable”] = “myvalue”; As you see the indexer accepts a string as a key and an object as the value. The Viewstate property is defined in the “System.Web.UI.Control” class. Since all ASP.NET pages and controls derive from this class then they all have access to the Viewstate property. The type of the Viewstate property is “System.Web.UI.StateBag”. The very special thing about the StateBag class is the ability to “track changes”. Tracking is by nature off, it can be turned on by calling the “TrackViewState()” method. Once tracking is on it cannot be turned off. Only when tracking is on, any change to the StateBag value will cause that item to be marked as “Dirty”.
Introducing Viewstate inside ASP.NET Context
When dealt within the context of ASP.NET then the Viewstate can be defined as the technique used by an ASP.NET web page to remember the change of state spanning multiple requests. As you know ASP.NET is a stateless technology; meaning that two different requests (two postbacks) to the same web page are considered completely unrelated. This raises the need of a mechanism to track the change of state for this web page between the first and second request.
The Viewstate of an ASP.NET page is created during the page life cycle and saved into the rendered HTML using in the “__VIEWSTATE” hidden HTML field. The value stored in the “__VIEWSTATE” hidden field is the result of serialization of two types of data:
This value is loaded during postbacks and is used to preserve the state of the web page.
One final thing to be explained here is the fact that ASP.NET server controls use Viewstate to store the values of their properties. What does this mean?
Well if you take a look at the source code of the Textbox server control for example, you will find that the “Text” property is defined like this: ASP.NET Page Life CycleGenerating the compiled class The first step (actually step 0 as explained in the info block below) of the life cycle is to generate the compiled class that represents the requested page. As you know the aspx page is consisted of combination of HTML and Server Controls. A dynamic compiled class is generated that represents this aspx page. This compiled class is then stored in the “Temporary ASP.NET Files” folder. As long as the aspx page is not modified (or the application itself is restarted in which case the request will actually be the first request and then the generation of the class will occur again) then future requests to the aspx page will be served by the same compiled class.
This compiled class will actually contain the programmatic definition of the controls defined in the aspx page. In order to fully understand the process of dynamic generation let us consider together the following example of a simple aspx page for collecting the username and password: Ok so now is the really interesting part. Start examining the code above and you will be able to notice the following:
PreInit (New to ASP.NET 2.0) The entry point of the page life cycle is the Pre Initialization phase aka “PreInit”. This is the only event where programmatic access to master pages and themes is allowed. Note that this event is not recursive, meaning that it is accessible only for the page itself and not for any of its child controls. InitNext is the Initialization phase aka “Init”. The “Init” event is fired reclusively for the page itself and for all the child controls in the hierarchy (which is created during the creation of the compiled class as explained earlier). Note that against many developers’ beliefs, the event is fired in a bottom to up manner and not up to bottom within the hierarchy. This means that following up with our previous example, the “Init” event is fired first for the most bottom control in the hierarchy then it is fired up the hierarchy until it is fired for the page itself. You can test this behavior yourself by adding a custom or user control to the page. Override the “OnInit” event handler in both the page and the custom (or user) control and add break points to both event handlers. Issue a request against the page and you will notice that the event handler for the control will be fired up before that of the page. InitComplete (New to ASP.NET 2.0)The initialization Complete event aka “InitComplete” signals the end of the Initialization phase. It is at the start of this event where tracking of ASP.NET Viewstate is turned on. Recall that the StateBag class (of which Viewstate is typped) has a tracking ability which is off by default and is turned on by calling the “TrackViewState()” method. Also recall that only when tracking is enabled any change to a Viewstate key will mark this item as “Dirty”. Well it is at the start of this event “InitComplete” where the “Page.TrackViewState()” is called and thus enabling tracking for the page Viewstate.
This event happens only at postbacks. This is a recursive event much like the “Init” event. In this event, the Viewstate which has been saved in the __ VIEWSTATE during the previous page visit (via the SaveViewState event) is loaded and then populated into the control hierarchy. LoadPostbackdataThis event happens only at postbacks. This is a recursive event much like the “Init” event. During this event the posted form data are loaded into the appropriate controls. For example assume that on your form you had a Textbox server control, you entered some text inside the Textbox and then posted the form. The text you have entered is what called postback data. This text is loaded during the LoadPostbackdata event and handed to the Textbox. That this why when you post a form you find that the posted data is loaded again into the appropriate controls. This behavior applies to most controls like the selected item of the drop down list and the “checked” state of a check box, etc… A very common conceptual error is the thought that Viewstate is responsible for preserving posted data. This is absolutely false; Viewstate has nothing to do with it. If you want a proof, disable the Viewstate on your Textbox control or even on the entire page and you will find that the posted data is still preserved. This is the virtue of LoadPostbackdata event. PreLaod (New to ASP.NET 2.0)This event indicates the end of system level initialization. LoadThis event is recursive much like the “Init” event. The important thing to note about this event is the fact that by now the page has been restored to its previous state in case of postback. That is because the LoadViewState and the LoadPostbackdata events are fired which means that the page Viewstate and postback data are now handed to the page controls. RaisePostbackEventThis event is fired only at postbacks. What this event does is inspecting all child controls of the page and determining if they need to fire any postback events. If it finds such controls then these controls fire their events. For example if you have a page with a Button server control and you click this button causing a postback; then the RaisePostbackEvent inspects the page and finds that the Button control has actually raised a postback event – in this case the Button Click event. The Button Click event is fired at this stage. LoadComplete (New to ASP.NET 2.0)This event signals the end of Load. Prerender (New to ASP.NET 2.0)This event allows for last updates before the page is rendered. PrerenderComplete (New to ASP.NET 2.0)This event signals the end of “Prerender”. SaveViewstateThis event is recursive much like the “Init” event. During this event, the Viewstate of the page is constructed and serialized into the __VIEWSTATE hidden field.
State Control is a new feature of ASP.NET 2.0. In ASP.NET 1.1 Viewstate was used to store two kinds of state information for a control:
This resulted in a fairly large __VIEWSTATE field. A very good example is the DataGrid server control. In ASP.NET 1.1 DataGrid uses Viewstate to store its UI state such as sorting and paging. So even if you wanted to disable Viewstate on the DataGrid and rebind the data source on each postback; you simply cannot do that if your DataGrid was using sorting or paging. The result was that the DataGrid ended up using Viewstate to store both its bounded data and its UI state such as sorting and paging.
ASP.NET 2.0 solved this problem by partitioning Viewstate into two parts:
The Control State is used to store the UI state of a control such as the sorting and paging of a DataGrid. In this case you can safely disable the DataGrid Viewstate (provided of course that you rebind the data source at each postback) and the sorting and paging still work simple because they are saved in the Control State. The Control State is also serialized and stored in the same __VIEWSTATE hidden field. The Control State cannot be set off. Render This is a recursive event much like the “Init” event. During this event the HTML that is returned to the client requesting the page is generated. UnloadThis is a recursive event much like the “Init” event. This event unloads the page from memory and releases any used resources. Role of Viewstate in the page life cycleViewstate in the “Init” event
The important thing to note in the “Init” event is that Viewstate tracking is not yet enabled. In order to demonstrate this let us take the following example.
In the “InitComplete” event the Viewstate tracking is enabled. If we take the same above example:
To better understand the role of Viewstate in these events let us take an example. Say that you have a simple aspx page that consists of the following:
Viewstate WalkthroughsOk so by now you should have a solid understanding about the page life cycle, the Viewstate, and the role of the Viewstate in the page life cycle. However, we are yet to discuss the cases that tests whether you are an advanced Viewstate user or not. In the next walkthroughs you shall tackle most of these cases. By the end of this section you can safely call yourself an advanced Viewstate user. Walkthrough1: Viewstate of an empty or Viewstate-disabled pageSo let us start by a very simple question. Will you have a value stored in the __VIEWSTATE field if you have a blank ASP.NET page or a page with Viewstate completely disabled? The answer is yes. As a test, create a blank ASP.NET page and run it. Open the View Source page and note the __VIEWSTATE field. You will notice that it contains a small serialized value. The reason is that the page itself saves 20 or so bytes of information into the __VIEWSTATE field, which it uses to distribute PostBack data and Viewstate values to the correct controls upon postback. So, even for a blank page or page with disabled Viewstate, you will see a few remaining bytes in the __VIEWSTATE field. Walkthrough2: What is stored in Viewstate?As mentioned previously, the data stored in the __VIEWSTATE field consists of the following:
Ok so let us assume that you have a web page with only a Label control on it. Now let us say that at design time you set the “Text” property of the Label to “statictext”. Now load the page and open the View Source page. You will see the __VIEWSTATE field. Do you think the “statictext” is saved there? The answer is for sure not. Recall from our discussion about generating the compiled class of the page that static properties of controls are assigned at the generated class. So when the page is requested the values stored at the generated class are displayed. As such static properties that are set at design time are never stored in the __VIEWSTATE field. However, they are stored in the generated compiled class and thus they show up at rendering the page. Now let us say that you did some changes to your page such that it consists of the following:
Let us now go one step further. Repeat the same exact previous scenario, with one exception: instead of adding the code that will change the value of the “Text” property at the “Page_Load” event handler; override the “OnPreInit” event handler and add the code there. Now first load the page and you will see the new text displayed in the Label. But do you think this time it is stored in the __VIEWSTATE field? The answer is no. the reason is that during the “PreInit” event Viewstate tracking is not yet enabled, so the change done to the “Text” property is not tracked and thus not saved during the “SaveViewState” event. As a proof, click the Button causing a postback. You will see that the value displayed inside the Label is the design time value “statictext”. Let us go even one further step. If you have been following this long article carefully you will recall that during the “Init” event tracking of Viewstate is not yet enabled. You have even seen an example in section [Viewstate in the “Init” event] of how an item keeps being not dirty even after it is being set. Now going back to our current example, you will most probably be tempted to consider that if we add the code that changes the value of the “Text” property inside the “OnInit” event handler you will get the same result as when you put it inside the “OnPreInit” event handler; after all tracking of Viewstate is not enabled yet during either event. Well if you think so then you are mistaken. Reason: also if you have been following this article carefully you will recall that the “InitComplete” event (where tracking of Viewstate is enabled) is not a recursive event; it is called only for the page itself but not for its child controls. This means that for the child controls, there is no “InitComplete” event; so where does the tracking of Viewstate starts? The answer is at the start of the “Init” event. So this means that for the page itself tracking of Viewstate is enabled at the “InitComplete” event; that is why during the “OnInit” event handler the item was still marked as not being “Dirty” even after modification. However, for child controls there is no “InitComplete” event so the Viewstate tracking is enabled as early as the “Init” event. And since – again as was explained earlier – the “Init” event is called recursively for the page and its controls in a up to bottom manner; then by the time the “Init” event of the page itself is fired, the “Init” event of the child controls is already being fired and thus Viewstate tracking for child controls is on by that time. As such adding the code that changes the value of the “Text” property inside the “OnInit” event handler will have the same effect as putting it inside the “Page_Load” event handler. Walkthorugh3: What is the larger Viewstate?Consider the following example: you have a two ASP.NET pages; page1.aspx and page2.aspx. Both pages contain only a single Label control. However in page1 the Label is declared at design time with its “Text” property set to a small string (say 10 characters). In page2 the Label is declared at design time with its “Text” property set to a lengthy string (say 1000 characters). Now load both pages at the same time and examine the View Source for both pages. Compare the two __VIEWSTATE fields; what do you find? You will find that both fields are of the same size even though one Label has its “Text” property storing 10 characters while the other has its “Text” property storing 1000 characters. If you have read walkthroughs 1 and 2, you will for sure know the reason: design time property values are not stored in the Viewstate. The __VIEWSTATE value for both pages is simply the bytes emitted by the page itself. Walkthrough4: Complete page life cycle scenarioIn this walkthrough we will go through the each of the relevant page life cycle events and see what role Viewstate has in each of these events. In this example we have as ASP.NET page with the following characteristics:
Disabling Viewstate would obviously reduce Viewstate size; but it surely kills the functionality along the way. So a little more planning is required… Consider the case where you have a page with a drop down list that should display the countries of the world. On the “Page_Load” event handler you bind the drop down list to a data source that contains the countries of the world; the code that does the binding is wrapped inside a “!IsPostback” condition. Finally on the page you have a button that when clicked should read the selected country from the drop down list. With the setup described above, you will end up with a large __VIEWSTATE field. This is due to the fact that data bound controls (like the drop down list) store their state inside the Viewstate. You want to reduce Viewstate; what options do you have?
If you implement Option1, you will reduce the Viewstate alright but with it you will also lose the list of countries on the first postback of the page. When the page first loads, the code in the “Page_Load” event handler is executed and the list of countries is bounded to the list. However because Viewstate is disabled on the list, this change of state is not saved during the “SaveViewState” event. When the button on the page is clicked causing a postback, and since the binding code is wrapped inside a “!IsPostback” condition, the “LoadViewState” event has nothing saved from the previous page visit and the drop down list is empty. If you implement Option2, you will reduce Viewstate size and you will not lose the list of countries on postback. However another problem arises: because the binding code is now executed at each “Page_Load”, the postback data is lost upon postback and every time the first item of the list will be selected. This is true because in the page life cycle the “LoadPostbackdata” event occurs before the “Load” event. Option3 is the correct option. In this option you have done the following:
Now take care that in Option3 you have successfully reduced Viewstate size and kept the functionality working; but this actually came to the cost of rebinding the drop down list at each postback. But the performance hit of revisiting the data source at each postback is nothing when compared with the performance boost gained from saving huge amount of bytes from being rendered at the client’s __VIEWSTATE field. This is especially true with the fact that most clients are connected to the internet via low speed dial up connections. Walkthrough6: Viewstate and Dynamic Controls
The first fact that you should know about dynamic controls is that they should be added to the page at each and every page execution. Never wrap the code that initializes and add the dynamic control to the page inside a “!IsPostback” condition. The reason is that since the control is dynamic, it is not included in the compiled class generated for the page. So the control should be added at every page execution for it to be available in the final control tree.
The second fact is that dynamic controls play “catch-up” with the page life cycle once they are added. Say that you did the following: Once the control is added to the “Controls” collection, it plays “catch-up” with the page life cycle and all the events that it missed are fired. This leads to a very important conclusion: you can add dynamic controls at any time during the page life cycle until the “PreRender” event. Even when you add the dynamic control in the “PreRender” event; once the control is added to the “Controls” collection, the “Init”, “LoadViewState”, “LoadPostbackdata”,”Load”, and “SaveViewstate” are fired for this control. This is called “catch-up”. Note thought that it is recommended that you add your dynamic controls during the “PreInit” or “Init” events. This is because it is best to add controls to the control tree before tracking Viewstate of other controls is enabled…
Finally what is the best practice for adding dynamic controls regarding Viewstate? Let us say that you want to add a Label at runtime and assign a value to its “Text” property. What is the best practice to do so? If you are thinking the below then you are mistaken: SummaryThis article explained the page life cycle and Viewstate in detail. If you are new to either of the topic, it is advised that you read this article more than once to fully grasp the idea. | ||||||||||||||||||||||||||||