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

NameDescription
ComponentClassNameComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembersComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternNameComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTagGeneric space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentTypeComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeNameComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
NameName identifies the component Inherited from Object (PRIM_OBJT)
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
ParentThe 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

NameDescription
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from Object (PRIM_OBJT)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Object (PRIM_OBJT)

Methods

NameDescription
AddAdd an item to the browser history
QueryString
GoBackNavigate to a prior URL
Step
GoForwardNavigate to a subsequent URL
Step

See also

All Component Classes

Technical Reference