BrowserHistoryAdd (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Operating mode
Preventing the use of the browser's "Back" key

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

BrowserHistoryAdd (Function)

In french: NavigateurHistoriqueAjoute

Adds an entry into the history of navigation by associating data. This data will be transmitted when going back to this entry.

Example

// Goes to the next application plane
CELL_Main.Plane++
// Adds an history entry
// The transmitted data is the plane number
BrowserHistoryAdd(CELL_Main.Plane, MyPage.Title, "#Plane" + CELL_Main.Plane)

Syntax

BrowserHistoryAdd(<Data> [, <Title> [, <URL>]])

<Data>: Type of data

Status associated with the page for the new history entry.

<Title>: Optional character string (with quotes)

New title for the page.
Caution: this title is currently ignored by most browsers.

<URL>: Optional character string (with quotes)

New URL that will be displayed by the browser. This URL is used for the display in the address bar only. Therefore, there is no need to use a valid URL. However, if the user copies this URL in order to use it in another browser, the page load will fail if the URL is not valid.

Remarks

Operating mode

The added data describes the status associated with the page for the new history entry.

If the Web user goes back to an entry in the history, the stored data will be transmitted to the "Move in the navigation history" event (optional page event). This event must process the data in order to restore the page status. This process must be associated with a procedure that expects the transmitted data in parameter:

// Event "Move in the navigation history (onpopstate)"
PROCEDURE <ProcedureName>(<Data>)

Example: This example adds the page into the history and stores the insertion time. Going back to the previous history page displays the time.

x is Variant
x.Time = TimeSys()
BrowserHistoryAdd(x, MyPage.Title, "#before")

x.Time = TimeSys()
BrowserHistoryAdd(x, MyPage.Title, "#after")

// Event "Move in the navigation history (onpopstate)"
PROCÉDURE ProcessHistory(stStatus)
Info(stStatus.Time)

Remark: Depending on the browser, the event "Move in the navigation history (onpopstate)" is also run when loading the page and when going back to the initial page display. In this case, the <Data> parameter transmitted to the event corresponds to Null.

Preventing the use of the browser's "Back" key

You can prevent the use of the browser's "Back" key. For more details, see Preventing the use of the browser's "Back" key.

Component: WDJS.DLL