Home > WebEOC > Admin Guide > HTML Conventions > Viewlink Tags

Viewlink Tags

The <viewlink> tag can provide a mechanism to jump to another view from within a board. For example, a summary list may have a <viewlink> tag that allows users to open a view showing a single record's detail.

<viewlink name="Detail" type="button">View Detail</viewlink> 

Using the board attributes in the tag, you can also navigate to views in different boards.

<viewlink name="Significant Events" type="button" board="Significant Events">View

For allowed values and requirements, refer to Attribute Definitions.

Tags

<viewlink>

Mechanism to navigate to another view; rendered as <a> or <button>. For example, a summary list may have a <viewlink> tag that allows users to open a view showing a single record's detail.

<viewlink name="Detail" type="button">View Detail</viewlink>

Attribute

Allowed Values

Requirements

Description

board

%boardname

Optional

Name of the board that contains the view to link to.

dialogwidth

NUMBER

Optional

Width of the dialog window that pops up with using the target="dialog" attribute; expressed as a percentage.

name|view

%viewname

Required

Name of the view to link to.

ondialogclose

Valid javascript

Optional

Used with target="dialog." This is the JavaScript to run when the dialog window closes.

refreshid

%id

Optional

Used with target="dialog." This is the ID of the containing element refreshed when the dialog closes.

table

%tablename

Optional

Name of the table that contains the view; overrides the board attribute.

target

(%iframeid|parent|self|top|dialog|window|tab)self

Implied

How the link is opened--that is, in a new tab, a dialog box, or a new browser window. When not included, the user leaves the existing view and navigates to the named view.

 

Explanation of allowed values:

  • %iframeid=element id

  • parent=parent view

  • self=current view

  • top=current window

  • dialog=a lightbox

    • ondialogclose – JavaScript function that is executed when the user closes the dialog box; this is used when more complex processing is necessary.

    • refreshid – identifier of an HTML element that should refresh when the user closes the dialog box; only the content of the target is refreshed.

  • window=separate browser window

  • tab=new tab in the current browser window

type

(button|link)link

Implied

How the tag is rendered.

*

*

Optional

Passes any HTML attribute–except onclick and href–through to the rendered tag.

You can also use the target attribute in conjunction with an <embedview> tag to change the view that shows in the <embedview> tag. The view can be from the same or different boards in a view. The embedded view works like any other view, including automatic refresh when new data is added. The <embedview> tag is used to embed one view inside another and is rendered as an <iframe>. The target attribute of the <viewlink> tag specifies which <embedview> tag is to be replaced with the new view by referencing an ID given to the <embedview> tag.

<viewlink name="Input" type="button" target="InPageEdit" >Edit</viewlink>
<embedview name="Blank View" id="InPageEdit" width="800" height="600"/>

Tips

  • The <viewlink> tag is useful for list/detail display views.

  • When possible, include a <returnbutton> tag to take you back to the first view.

  • A view link within the <eocrepeatallrecords> block allows the editing of an existing record. A view link outside of the <eocrepeatallrecords> block creates a new record.

Note: The <viewlink> tag was modified in WebEOC 7.2 to allow view linking to views in other boards and specify the view linking behavior when working with embedded views.

<tablabel>

With WebEOC 8.4, you can specify tab as the value of the target attribute in the <viewlink>. Also with 8.4, you can specify a label for the tab using the <tablabel> tag. If this tag is not included in the <viewlink>, the tab's label is the board name. The parent of <tablabel> must be a <viewlink> tag.

Example

<viewlink class="webeoc-create" name="Input" target="tab"><tablabel>Create Item</tablabel>Create Item</viewlink>

<viewparameter>

Added in WebEOC 8.2, this tag allows an arbitrary parameter to pass from one view to the next; parent must be a <viewlink> tag. 

Easily added to a board’s display or input view, each <viewparameter> element is given a name, and the text embedded within the element contains the value of the parameter. This feature helps support more advanced board building by making the parameter available in XML data when you open the viewlink-targeted view.

Attribute

Allowed Values

Requirements

Description

name

text

Required

Name of the parameter that will be available in the ViewParameter node of the XML data of the targeted view.

Examples 

<viewlink type="link" name="Input">
<viewparameter name="recordcount">
<expression name="recordcount">count(*)</expression>
</viewparameter>Edit
</viewlink>

Any data put between the <viewparameter> and </viewparameter> tags passes by the name in the open tag. Multiple parameters can pass on one <viewlink>. To capture it on the linked view and display the value in the parameter, use something like the following:

<value-of select="/data/ViewParameter[@name='parameterName']"/>

To use the tag in an IF test:

<if test="/data/ViewParameter[@name='parameterName'] = 'Test data!'"> 
This is Test Data! 
</if> 
You must to post a comment.
Last modified

Tags

Classifications

This page has no classifications.