O4WBreadCrumbs routine [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== O4WBreadCrumbs routine     ======


 
==== Description ====
 
Sets up a section to track "breadcrumbs" (links to previously-visited sections) in the section <breadcrumbContainer>.  Each section that will be tracked (specified as an @VM-delimited list in <breadcrumbSections>, with optional "friendly names" specified in the associated <breadcrumbNames> parameter) will initially be hidden.  When the breadcrumbs are displayed, the style specified in <breadcrumbStyle> (if any) will be applied to the <breadcrumbContainer> section. If you wish the user to be alerted if they attempt to move out of a section (either via breadcrumbs or via manually changing the URL on the browser line) after they have made changes to a form, set the corresponding value in <trackchanges> to '1'.  Specify “-1” for the <breadcrumbflags> value if you want the breadcrumb to send a BCLICK_NOTIFY message to the host routine when clicked. To move to a section, and put its value into the 'breadcrumb' list, call O4WSetBreadcrumb.
 
==== Syntax ====
 
O4WBREADCRUMBS(<breadcrumbContainer>, <breadcrumbSections>, <breadcrumbNames>, <breadcrumbimages>, <breadcrumbflags>, <trackchanges>, <breadcrumbStyle>)
 
==== Parameters ====
 
The function has the following parameters:

^Parameter^Description^
|breadCrumbContainer|The URL of the stylesheet to be used.|
|breadCrumbSections|An @vm delimited list of breadCrumbSections.  Each section that will be tracked will initially be hidden.|
|breadCrumbNames|<Optional>An @vm delimited list of "friendly name" values associated with the breadCrumbSections parameter.|
|breadCrumbImages|<Optional>An @vm delimited list of [[o4wimage|O4WImage]] images associated with the breadCrumbSections parameter.|
|breadCrumbFlags|<Optional>An @vm delimited list.|
|trackChanges|Boolean.  When true, the user to be alerted if they attempt to move out of a section (either via breadcrumbs or via manually changing the URL on the browser line) after they have made changes to a form, set the corresponding value in <trackchanges> to '1'.|
|breadCrumbStyle|When the breadcrumbs are displayed, the style specified in <breadcrumbStyle> (if any) will be applied to the <breadcrumbContainer> section.||

 
==== See Also ====
 
To move to a section, and put its value into the breadcrumb list, call [[o4wsetbreadcrumb|O4WSetBreadCrumb]].