History

Overview

The History interface allows manipulation of the browser session history, that is the pages visited in the tab or frame that the current page is loaded in.

Location

 

forward

This asynchronous method goes to the next page in session history, the same action as when the user clicks the browser's Forward button; this is equivalent to history.go(1). Calling this method to go forward beyond the most recent page in the session history has no effect and doesn't raise an exception.

 

method forward: Int32

 

Int32 forward()

 

func forward() -> Int32

 

Int32 forward()

 

Function forward() As Int32

go

Asynchronously loads a page from the session history, identified by its relative location to the current page, for example -1 for the previous page or 1 for the next page. If you specify an out-of-bounds value (for instance, specifying -1 when there are no previously-visited pages in the session history), this method silently has no effect. Calling go() without parameters or a value of 0 reloads the current page. Internet Explorer lets you specify a string, instead of an integer, to go to a specific URL in the history list.

 

method go(pardelta: dynamic): String

 

String go(dynamic pardelta)

 

func go(_ pardelta: dynamic) -> String

 

String go(dynamic pardelta)

 

Function go(pardelta As dynamic) As String

Parameters:

  • pardelta:

length

 

property length: Int32 read;

 

Int32 length { get; }

 

var length: Int32 { get{} }

 

Int32 length { __get; }

 

ReadOnly Property length() As Int32

pushState

Pushes the given data onto the session history stack with the specified title (and, if provided, URL). The data is treated as opaque by the DOM; you may specify any JavaScript object that can be serialized.  Note that all browsers but Safari currently ignore the title parameter. For more information, see Working with the History API.

 

method pushState(parstate: dynamic; partitle: dynamic; parurl: dynamic): dynamic

 

dynamic pushState(dynamic parstate, dynamic partitle, dynamic parurl)

 

func pushState(_ parstate: dynamic, _ partitle: dynamic, _ parurl: dynamic) -> dynamic

 

dynamic pushState(dynamic parstate, dynamic partitle, dynamic parurl)

 

Function pushState(parstate As dynamic, partitle As dynamic, parurl As dynamic) As dynamic

Parameters:

  • parstate:
  • partitle:
  • parurl:

replaceState

Updates the most recent entry on the history stack to have the specified data, title, and, if provided, URL. The data is treated as opaque by the DOM; you may specify any JavaScript object that can be serialized.  Note that all browsers but Safari currently ignore the title parameter. For more information, see Working with the History API.

 

method replaceState(parstateObj: dynamic; partitle: dynamic; parurl: dynamic): dynamic

 

dynamic replaceState(dynamic parstateObj, dynamic partitle, dynamic parurl)

 

func replaceState(_ parstateObj: dynamic, _ partitle: dynamic, _ parurl: dynamic) -> dynamic

 

dynamic replaceState(dynamic parstateObj, dynamic partitle, dynamic parurl)

 

Function replaceState(parstateObj As dynamic, partitle As dynamic, parurl As dynamic) As dynamic

Parameters:

  • parstateObj:
  • partitle:
  • parurl:

scrollRestoration

 

property scrollRestoration: String read write;

 

String scrollRestoration { get; set; }

 

var scrollRestoration: String { get{} set{} }

 

String scrollRestoration { __get; __set; }

 

Property scrollRestoration() As String

state

 

property state: dynamic read;

 

dynamic state { get; }

 

var state: dynamic { get{} }

 

dynamic state { __get; }

 

ReadOnly Property state() As dynamic

 

length

 

property length: Int32 read;

 

Int32 length { get; }

 

var length: Int32 { get{} }

 

Int32 length { __get; }

 

ReadOnly Property length() As Int32

scrollRestoration

 

property scrollRestoration: String read write;

 

String scrollRestoration { get; set; }

 

var scrollRestoration: String { get{} set{} }

 

String scrollRestoration { __get; __set; }

 

Property scrollRestoration() As String

state

 

property state: dynamic read;

 

dynamic state { get; }

 

var state: dynamic { get{} }

 

dynamic state { __get; }

 

ReadOnly Property state() As dynamic

 

forward

This asynchronous method goes to the next page in session history, the same action as when the user clicks the browser's Forward button; this is equivalent to history.go(1). Calling this method to go forward beyond the most recent page in the session history has no effect and doesn't raise an exception.

 

method forward: Int32

 

Int32 forward()

 

func forward() -> Int32

 

Int32 forward()

 

Function forward() As Int32

go

Asynchronously loads a page from the session history, identified by its relative location to the current page, for example -1 for the previous page or 1 for the next page. If you specify an out-of-bounds value (for instance, specifying -1 when there are no previously-visited pages in the session history), this method silently has no effect. Calling go() without parameters or a value of 0 reloads the current page. Internet Explorer lets you specify a string, instead of an integer, to go to a specific URL in the history list.

 

method go(pardelta: dynamic): String

 

String go(dynamic pardelta)

 

func go(_ pardelta: dynamic) -> String

 

String go(dynamic pardelta)

 

Function go(pardelta As dynamic) As String

Parameters:

  • pardelta:

pushState

Pushes the given data onto the session history stack with the specified title (and, if provided, URL). The data is treated as opaque by the DOM; you may specify any JavaScript object that can be serialized.  Note that all browsers but Safari currently ignore the title parameter. For more information, see Working with the History API.

 

method pushState(parstate: dynamic; partitle: dynamic; parurl: dynamic): dynamic

 

dynamic pushState(dynamic parstate, dynamic partitle, dynamic parurl)

 

func pushState(_ parstate: dynamic, _ partitle: dynamic, _ parurl: dynamic) -> dynamic

 

dynamic pushState(dynamic parstate, dynamic partitle, dynamic parurl)

 

Function pushState(parstate As dynamic, partitle As dynamic, parurl As dynamic) As dynamic

Parameters:

  • parstate:
  • partitle:
  • parurl:

replaceState

Updates the most recent entry on the history stack to have the specified data, title, and, if provided, URL. The data is treated as opaque by the DOM; you may specify any JavaScript object that can be serialized.  Note that all browsers but Safari currently ignore the title parameter. For more information, see Working with the History API.

 

method replaceState(parstateObj: dynamic; partitle: dynamic; parurl: dynamic): dynamic

 

dynamic replaceState(dynamic parstateObj, dynamic partitle, dynamic parurl)

 

func replaceState(_ parstateObj: dynamic, _ partitle: dynamic, _ parurl: dynamic) -> dynamic

 

dynamic replaceState(dynamic parstateObj, dynamic partitle, dynamic parurl)

 

Function replaceState(parstateObj As dynamic, partitle As dynamic, parurl As dynamic) As dynamic

Parameters:

  • parstateObj:
  • partitle:
  • parurl: