ScriptManager.AddHistoryPoint Method

Definition

Namespace:

System.Web.UI

Assembly:

System.Web.Extensions.dll

Creates a history point and adds it to the browser's history stack.

Overloads

AddHistoryPoint(NameValueCollection, String)	Creates a history point and adds it to the browser's history stack, using the specified state data collection and state title.
AddHistoryPoint(String, String)	Creates a history point and adds it to the browser's history stack, using the specified state key and state value.
AddHistoryPoint(String, String, String)	Creates a history point and adds it to the browser's history stack, using the specified state key, state value, and state title.

Remarks

These method overloads enable you to define server state, and optionally the title of the history entry in the browser. When you create a history point, serialized and encrypted data is appended to the URL of the Web page and an entry is included in the browser's history stack. You can use the state data to re-create the page when any subsequent server navigation event is raised. For more information, see Managing Browser History Using Server Controls.

AddHistoryPoint(NameValueCollection, String)

Creates a history point and adds it to the browser's history stack, using the specified state data collection and state title.

public:
 void AddHistoryPoint(System::Collections::Specialized::NameValueCollection ^ state, System::String ^ title);

public void AddHistoryPoint (System.Collections.Specialized.NameValueCollection state, string title);

member this.AddHistoryPoint : System.Collections.Specialized.NameValueCollection * string -> unit

Public Sub AddHistoryPoint (state As NameValueCollection, title As String)

Parameters

state

NameValueCollection

A collection of key/value pairs that contain the data for the state.

title

String

The text that will be added to the browser's history stack as the title for this state.

Remarks

Use this method to create a history point when you want to save more than one key/value pair for the state data. When you create a history point, serialized and encrypted data is appended to the URL of the Web page and an entry is included in the browser's history stack. If the title parameter is null, the title of the Web page is used as the title of the state entry in the history stack.

You can use the state data to re-create the page when any subsequent server navigation event is raised. For more information, see Managing Browser History Using Server Controls.

AddHistoryPoint(String, String)

Creates a history point and adds it to the browser's history stack, using the specified state key and state value.

public:
 void AddHistoryPoint(System::String ^ key, System::String ^ value);

public void AddHistoryPoint (string key, string value);

member this.AddHistoryPoint : string * string -> unit

Public Sub AddHistoryPoint (key As String, value As String)

Parameters

key

String

The key part of the key/value pair that identifies the state of the Web page.

value

String

The value part of the key/value pair that identifies the state of the Web page.

Remarks

Use this method to create a history point when you only want to save a value to identify the state. When you create a history point, serialized and encrypted data is appended to the URL of the Web page and an entry is included in the browser's history stack. The title of the Web page is used as the title of the state entry in the history stack.

You can use the state data to re-create the page when any subsequent server navigation event is raised. For more information, see Managing Browser History Using Server Controls.

AddHistoryPoint(String, String, String)

Creates a history point and adds it to the browser's history stack, using the specified state key, state value, and state title.

public:
 void AddHistoryPoint(System::String ^ key, System::String ^ value, System::String ^ title);

public void AddHistoryPoint (string key, string value, string title);

member this.AddHistoryPoint : string * string * string -> unit

Public Sub AddHistoryPoint (key As String, value As String, title As String)

Parameters

key

String

The key part of the key/value pair that identifies the state of the Web page.

value

String

The value part of the key/value pair that identifies the state of the Web page.

title

String

The text that will be added to the browser's history stack as the title for this state.

Remarks

Use this method to create a history point when you want to save a value to identify the state and a title for the state. When you create a history point, serialized and encrypted data is appended to the URL of the Web page and an entry is included in the browser's history stack. If the title parameter is null, the title of the Web page is used as the title of the state entry in the history stack.

You can use the state data to re-create the page when any subsequent server navigation event is raised. For more information, see Managing Browser History Using Server Controls.