Web History (PRIM_WEB.History)

Browser History object

Ancestors - Object (PRIM_OBJT)

Details

History provides access to the browser history.
 
Manipulation of the browser history is limited to the currently active domain and is effectively a place to store QueryStrings that will be appended to the URL.
 
This is primarily useful for storing deeplinking information generated by user navigation.

Example

In this example, every time an item in a list gets focus the details of an employee are displayed and an item is added to the history.
 
When the user uses the history to show a page, the URLChanged event can be monitored and the URLParameters processed to detect the employee number.
Evtroutine Handling(#List.ItemGotFocus)
 
   #Com_owner.Activate( #Empno )
 
   #Sys_Web.history.Add( ("Employee=&1").Substitute( #Empno ) )
 
Endroutine
 
Evtroutine Handling(#sys_web.URLChanged)
 
   For Each(#Parameter) In(#sys_web.URLParameters)
 
      Continue If(#Parameter.Name.Uppercase <> Employee)
 
      #Com_owner.Activate( #Parameter.Value.uppercase)
 
      Leave
 
   Endfor
 
Endroutine

Properties

Name Description
ComponentClassName ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembers ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternName ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTag Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentType ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeName ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
Name Name identifies the component Inherited from Object (PRIM_OBJT)
Owner Owner owns this component Inherited from Object (PRIM_OBJT)
Parent The component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances Inherited from Object (PRIM_OBJT)

Events

Name Description
CreateInstance CreateInstance is signalled when an instance of a component is created Inherited from Object (PRIM_OBJT)
DestroyInstance DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Object (PRIM_OBJT)

Methods

Name Description
Add Add an item to the browser history
QueryString, Signal
GoBack Navigate to a prior URL
Step
GoForward Navigate to a subsequent URL
Step
Replace Replace the current history item
QueryString, Signal

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020