PRIM_WEB.Routing (PRIM_WEB.Routing)
This component class defines the features of a helper component that is accessed using the Routing property of the PRIM_WEB.Application component class. Use the Routing class instance to access the state of the current routing request.
Ancestors - Object (PRIM_OBJT)
The Routing class defines the features of a helper component accessed using a new Routing property of the PRIM_WEB.Application component class. Use the Routing class instance to access the state of the current routing request.
| Name | Description |
|---|---|
| ActivePath | A read-only property that supplies a string containing that piece of the current URL path component that has been processed by the routing framework |
| ActiveRoutes | This read-only property provides access to the collection of PRIM_WEB.Route instances resolved by the routing engine for the current ActivePath |
| 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) |
| FullPath | A read-only property that supplies a string containing that the current URL path component. It is a concatenation of the RootPath and the ActivePath properties |
| 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) |
| PathParameters | Read-only property providing access to an instance of the class PRIM_WEB.RoutingPathParameters which is a read-write collection of PRIM_WEB.RoutingPathParameter components. Each instance of class PRIM_WEB.RoutingPathParameter contains a Name/Value pair with the name corresponding to the name assigned to the path variable and the value corresponding to the actual value for the variable in the current URL path component. For example, the path '/Categories/Fluffy/Products/P123' for the path 'Categories/{CategoryId}/Products/{ProductId}' would supply the value 'Fluffy' for the parameter named CategoryId and 'P123' for the parameter named ProductId |
| RootPath | Read-only property that supplies a string containing that piece of the current URL path component that identifies the current web page |
| RoutingProvider | A component reference that has implemented PRIM_WEB.IRouterProvider to enable an application with a dynamaic router |
| Name | Description |
|---|---|
| CreateInstance | CreateInstance is signalled when an instance of a component is created Inherited from PRIM_WEB.Routing (PRIM_WEB.Routing) |
| DestroyInstance | DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from PRIM_WEB.Routing (PRIM_WEB.Routing) |
| Name | Description |
|---|---|
| Navigate | Method used to request that the application navigate to the path supplied as the path parameter
Result, Path, Signal, Query |
| Replace | Method used to request that the application navigate to the path supplied as the path parameter and replace the current item in the browser history
Result, Path, Signal, Query |