Hyperlinking Screens

Hyperlinking in Canvas allows you to open another Canvas screen from the screen you are currently viewing.

Hyperlinking Via Controls

A limited set of Canvas controls support a non-scripted method to hyperlink to other screens using the same hyperlink modes described below.

• See the Alarm Grid and CygNet Grid for information about adding a non-scripted hyperlink to a grid row.
• See the Map for information about adding a non-scripted hyperlink to image and shape visual items on a map layer.
• See the Navigation Button for information about adding a non-scripted button to your screen.
• See the Text Tool for information about adding a non-scripted link to your screen.

Hyperlinking Via Script

Hyperlinking is accomplished via script using the Hyperlink method on the sending (hyperlinking) screen and the OpenedViaHyperlink event on the receiving (hyperlinked) screen. Hyperlinking is supported between screens, objects, and Nested Views in Canvas, Canvas.View, and Canvas.View.Lite. The Hyperlink method supports several modes:

• Open — Open a designated screen in a new window (default).
• Modal open — Open a designated screen in a new modal window. A modal window is a type of popup that is subordinate to a parent window that appears in front of the parent and usurps the parent’s control. You cannot interact with the parent window until the modal window has been closed. This type of window is used when you want a user to focus on or interact with information in the popup.
• Open and close — Open a designated screen in a new window and close the current screen.
• Replace — Replace the current screen with the designated screen.
• Replace with navigation — Replace the current screen with the specified screen and add a navigation toolbar to the top of the screen.
• Close — Close the current screen.

Optionally, you can pass a siteService, facility ID, or a data object to a hyperlinked screen.

Hyperlink Method

The Hyperlink method is included on the Screen object.

Syntax

Objects.Screen.Hyperlink(path, source, mode);

Parameters

There are several parameters that can be passed in via the Hyperlink method:

Hyperlinking Modes Example

The following example code shows the four hyperlink modes applied to four buttons on a screen. The path of the hyperlink is defined in the Objects.HyperlinkEditBox.Text:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
public ScreenClass()
{
    // control event handler code goes here -- do not modify
    Objects.Button4.Click += new EventHandler(this.Button4_Click);
    Objects.Button2.Click += new EventHandler(this.Button2_Click);
    Objects.Button1.Click += new EventHandler(this.Button1_Click);
    Objects.Button3.Click += new EventHandler(this.Button3_Click);
    // add your custom initialization code here
}
#region Button3
private void Button3_Click(object sender, EventArgs args)
{
    Objects.Screen.Hyperlink(Objects.HyperlinkEditBox.Text, CanvasFileSource.Local, HyperlinkMode.Open);
}
#endregion
#region Button1
private void Button1_Click(object sender, EventArgs args)
{
    Objects.Screen.Hyperlink(Objects.HyperlinkEditBox.Text, CanvasFileSource.Local, HyperlinkMode.OpenAndClose);
}
#endregion
#region Button2
private void Button2_Click(object sender, EventArgs args)
{
    Objects.Screen.Hyperlink(Objects.HyperlinkEditBox.Text, CanvasFileSource.Local, HyperlinkMode.Replace);
}
#endregion
#region Button4
private void Button4_Click(object sender, EventArgs args)
{
    Objects.Screen.Hyperlink(Objects.HyperlinkEditBox.Text, CanvasFileSource.Local, HyperlinkMode.ReplaceWithNavigation);
}
#endregion

OpenedViaHyperlink Event

The mechanism by which Canvas accesses this object is the OpenedViaHyperlink event on the hyperlinked screen, which is triggered whenever a screen is opened via a hyperlink. The screen issuing the hyperlink must also provide a value for a data parameter; without this custom data, the event will not fire.

The event requires a parameter that will contain the object that was passed into the Hyperlink method. This way the hyperlinking screen can pass generic data to the hyperlinked screen.

For example, Hyperlink_Screen_A.can can hyperlink to Hyperlink_Screen_B.can and pass in a SiteService and facility to the recipient Text Tool(s). The hyperlinked screen will load the screen, load the SiteService and facility as originally configured, then clear out the original values, and replace the screen with the overridden values from the hyperlinking screen.

Passing a SiteService or Facility Example

The following example code shows how to pass a SiteService and facility to a hyperlinked screen via a button click event:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
public void ScreenClassInitializer()
{
    // control event handler code goes here -- do not modify
     
    Objects.Button1.Click += new EventHandler(this.Button1_Click);
    Objects.Button2.Click += new EventHandler(this.Button2_Click);
     
    // add your custom initialization code here
}
#region Button1
 
private void Button1_Click(object sender, EventArgs args)
{
    Objects.Screen.Hyperlink(@"C:\Canvas Screens\Hyperlink\Hyperlink_Screen_B.can",
    CanvasFileSource.Local,
    HyperlinkMode.Open,
    Objects.Screen.CygNetConfiguration.SiteService.SiteService,
    Objects.Screen.CygNetConfiguration.Facility.FacilityID,
    DateTime.Now);
}
 
#endregion
#region Button2
 
private void Button2_Click(object sender, EventArgs args)
{
    Objects.Screen.Hyperlink(@"C:\Canvas Screens\Hyperlink\Hyperlink_Screen_B.can",
    CanvasFileSource.Local,
    HyperlinkMode.ReplaceWithNavigation,
    Objects.Screen.CygNetConfiguration.SiteService.SiteService,
    Objects.Screen.CygNetConfiguration.Facility.FacilityID,
    DateTime.Now);
}
#endregion

Passing an Object Example

The following example code snippet shows how to pass a DateTime object to a Text Tool on a hyperlinked screen:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
public ScreenClass()
{
    // control event handler code goes here -- do not modify
    Objects.Screen.OpenedViaHyperlink += new EventHandler(this.Screen_OpenedViaHyperlink);
    // add your custom initialization code here
}
#region Screen
private void Screen_OpenedViaHyperlink(object sender, EventArgs args)
{
    var hyperlinkEvent = args as OpenedViaHyperlinkEventArgs;
    var date = (DateTime)hyperlinkEvent.Data;
    Objects.TextTool3.Text = date.ToString();
}
#endregion