SetStateHash - cWebApp
Changes the currently active state hash
Type: Procedure
Parameters
| Parameter | Type | Description |
|---|---|---|
| sStateHash | String | New active state hash |
| sTitle | String | State hash title passed to the browser (usually ignored) |
| bReplace | Boolean | If True, the current state is replaced instead of creating a new history item |
Syntax
Procedure SetStateHash String sStateHash String sTitle Boolean bReplace
Call Example
Send SetStateHash sStateHash sTitle bReplace
Description
This procedure changes the currently active state hash. It is called by the framework when needed and it will add a new history item or replace the current history item. The state hash is converted into a URL by calling StateHashToUrl and calls HistoryReplaceState or HistoryPushState.
Note that peApplicationStateMode influences the behavior of this procedure.
This procedure should be used to manually set a state hash, although it is advised to use UpdateStateHash in the current view, which will generate a new hash and then call SetStateHash.
This method is asynchronous.