Namespace: Consultingwerk.SmartFramework.Menu.Routes
Class 
RouteDefinition Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartFramework.Menu.Routes.RouteDefinition

Inherits: Progress.Lang.Object

File:RouteDefinition
Purpose:Describes an Angular 2 Route
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Apr 08 09:10:52 CEST 2017
Purpose: Gets and sets the template for the text in the Breadcrump
Navigation
Notes: When this is unset (empty), the BrowserTitleTemplate
will be used: If there is no BreadcrumbLabelTemplate defined,
then the Breadcrumb component will use the BrowserTitleTemplate
as is (no parsing of template variables). If that is not defined
either, it will simply display the route path (a last resort
fallback - ideally all routes should define a breadcrumb
label template, a browser title template, or both).

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ Progress.Json.ObjectModel.JsonObject ToJson () Returns the JSON representation of the route
+ Validate () Validates the route settings

Top Constructor Summary
Options Name Purpose
+ RouteDefinition () Constructor for the RouteDefinition class
+ RouteDefinition (character, character) Constructor for the RouteDefinition class
+ RouteDefinition (character, character, character[], character[], character[]) Constructor for the RouteDefinition class

Top Property Summary
Options Name Purpose
+ CHARACTER BreadcrumbLabelTemplate
+ CHARACTER BrowserTitleTemplate
+ Consultingwerk.SmartFramework.Menu.Routes.ListRouteDefinition Children
+ CHARACTER DataSourceNames
+ CHARACTER FieldNames
+ CHARACTER FormId
+ CHARACTER FormTemplateUrl
+ CHARACTER Parameter
+ CHARACTER Path
+ CHARACTER PathParameters


Method Detail
Top

PUBLIC Progress.Json.ObjectModel.JsonObject ToJson ()
Purpose: Returns the JSON representation of the route
Notes:

Returns Progress.Json.ObjectModel.JsonObject
The JSON object describing the route
Top

PUBLIC Validate ()
Purpose: Validates the route settings
Notes:



Constructor Detail
Top

PUBLIC RouteDefinition ()
Purpose: Constructor for the RouteDefinition class
Notes:

Top

PUBLIC RouteDefinition (character, character)
Purpose: Constructor for the RouteDefinition class
Notes:

Parameters:
pcPath CHARACTER
The value of the Path property
pcFormTemplateUrl CHARACTER
The value of the FormTemplateUrl property
Top

PUBLIC RouteDefinition (character, character, character[], character[], character[])
Purpose: Constructor for the RouteDefinition class
Notes:

Parameters:
pcPath CHARACTER
The value of the Path property
pcFormTemplateUrl CHARACTER
The value of the FormTemplateUrl property
pcPathParameters CHARACTER
The value for the PathParameters property
pcDataSourceNames CHARACTER
The value for the DataSourceNames property
pcFieldNames CHARACTER
The value for the FieldNames property


Property Detail
Top

PUBLIC CHARACTER BreadcrumbLabelTemplate

Returns CHARACTER
Top

PUBLIC CHARACTER BrowserTitleTemplate

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartFramework.Menu.Routes.ListRouteDefinition Children

Returns Consultingwerk.SmartFramework.Menu.Routes.ListRouteDefinition
Top

PUBLIC CHARACTER DataSourceNames

Returns CHARACTER
Top

PUBLIC CHARACTER FieldNames

Returns CHARACTER
Top

PUBLIC CHARACTER FormId

Returns CHARACTER
Top

PUBLIC CHARACTER FormTemplateUrl

Returns CHARACTER
Top

PUBLIC CHARACTER Parameter

Returns CHARACTER
Top

PUBLIC CHARACTER Path

Returns CHARACTER
Top

PUBLIC CHARACTER PathParameters

Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:07:36