saveHistory Behavior

Enables the object to persist data in the browser history.

Syntax

XML <Prefix: CustomTag ID=sID STYLE="behavior:url('#default#saveHistory')" />
HTML <ELEMENT STYLE="behavior:url('#default#saveHistory')" ID=sID>
Scripting object.style.behavior = "url('#default#saveHistory')"
object.addBehavior ("#default#saveHistory")

Possible Values

Prefix Prefix that associates the CustomTag with an XML namespace. This prefix is set using the XMLNS attribute of the HTML tag.
CustomTag User-defined tag.
sID String that specifies a unique identifier for the object.

Members Table

The following table lists the members exposed by the saveHistory object. Click a tab on the left to choose the type of member you want to view.
Attributes/Properties
Property Description
XMLDocument Retrieves a reference to the XML Document Object Model (DOM) exposed by the object.
Events
Event Description
onload Fires from a persistent element when the page reloads.
onsave Fires from a persisted element when the Web page is saved or bookmarked, or when the user navigates away from the page.
Methods
Method Description
getAttribute Retrieves the value of the specified attribute.
removeAttribute Removes the specified attribute from the object.
setAttribute Sets the value of the specified attribute.

Remarks

The saveHistory behavior saves the current state of the page when the user navigates away from the page. When the user returns to the page by pressing the back or forward button, the values are restored.
The saveHistory behavior persists only for the current session. When the user navigates away from the page containing the saveHistory behavior, the data is persisted in a UserData store. The saveHistory behavior uses one UserData store for the entire document. Thus, if two elements write the same attribute, the first is overwritten by the second. The UserData store is saved in an in-memory stream and is not saved to disk. Therefore, it is not available after the user closes Microsoft® Internet Explorer.
For example, a page with several dynamically updated styles might save these updates using the onload and onsave event handlers. The style values can be saved as attributes when onsave fires, and restored when onload fires.
To use the saveHistory behavior, use a meta tag that identifies the type of persistence.
   <META NAME="save" CONTENT="history">
The required style can be set inline or in the document header, as follows:
   <STYLE>
.sHistory {behavior:url(#default#savehistory);}
</STYLE>
An ID is optional for saveHistory, but including one improves performance.
The saveHistory behavior is available as of Internet Explorer 5, in the Microsoft Win32® and Unix platforms.

Example

This example uses the saveHistory behavior to persist information after the user leaves and subsequently returns to the page.
<HTML>
<HEAD>
<META NAME="save" CONTENT="history">
<STYLE>
.sHistory {behavior:url(#default#savehistory);}
</STYLE>
</HEAD>
<BODY>
<INPUT class=sHistory type=text id=oPersistInput>
</BODY>
</HTML>
This feature requires Microsoft® Internet Explorer 5 or later. Click the following icon to install the latest version. Then reload this page to view the sample.

Applies To

A, ACRONYM, ADDRESS, AREA, B, BIG, BLOCKQUOTE, BUTTON, CAPTION, CENTER, CITE, CODE, DD, DEL, DFN, DIR, DIV, DL, DT, EM, FONT, FORM, hn, HR, I, IMG, INPUT type=button, INPUT type=checkbox, INPUT type=file, INPUT type=hidden, INPUT type=image, INPUT type=password, INPUT type=radio, INPUT type=reset, INPUT type=submit, INPUT type=text, KBD, LABEL, LI, LISTING, MAP, MARQUEE, MENU, OBJECT, OL, OPTION, P, PLAINTEXT, PRE, Q, S, SAMP, SELECT, SMALL, SPAN, STRIKE, STRONG, SUB, SUP, TABLE, TEXTAREA, TT, U, UL, VAR, XMP