PRIM_WEB.Router (PRIM_WEB.Router)

A simple component class that acts as the root of a tree of routes. It is associated with a PRIM_MD.ViewContainer instance to activate routing on that view container.

Ancestors - PRIM_WEB.Routable (PRIM_WEB.Routable)Object (PRIM_OBJT)

Details

The Router class acts as the root of a tree of routes.
 
It is associated with a PRIM_MD.ViewContainer instance to activate the routing on a view container.
 
It inherits from PRIM_WEB.Routable so that it can be the parent of PRIM_WEB.Route instances.

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)
RelatedReference Reference to an object instance to be stored for this item that provides a convenient, generic storage point that joins the Routable instance to a data object. This data object is then available to support specific processing of a routable object, like the storage of additional user interface components and data for authorization checks. Inherited from PRIM_WEB.Routable (PRIM_WEB.Routable)
Router A read-only property that traverses up the parent chain to find the first parent that is a PRIM_WEB.Router or *NULL if not found Inherited from PRIM_WEB.Routable (PRIM_WEB.Routable)

Events

Name Description
CreateInstance CreateInstance is signalled when an instance of a component is created Inherited from PRIM_WEB.Routable (PRIM_WEB.Routable)
DestroyInstance DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from PRIM_WEB.Routable (PRIM_WEB.Routable)
Match This event is signalled when the active path has been matched
Path, Route, Allow, Redirect

Methods

Name Description
CreateRoute Method to support creation of a route when building a dynamic router Inherited from PRIM_WEB.Routable (PRIM_WEB.Routable)
Result, Path, View, Parent
ProvideRouter A router implements the PRIM_WEB.IRouterProvider interface, returning itself when a router is requested
Result

See also

All Component Classes

Technical Reference