The Broadcast Message Received event is called when a broadcast message from another screen is received.

See Broadcast a Message Via Script for more information about using this event.

Example

Canvas.Shared.BroadcastMessageEventArgs

1
var argument = args as .Shared.BroadcastMessageEventArgs;

See Event Argument Type for more information about EventArgs.

The Click event is called when the user clicks once on the control with the left mouse button.

Examples

1
2
3
4
5
6
7
8
9
10
Objects.Button1.Click += new EventHandler(this.Button1_Click);
 

Objects.CheckBox1.Click += new EventHandler(this.CheckBox1_Click);

 
Objects.Image1.Click += new EventHandler(this.Image1_Click);


Objects.TextTool1.Click += new EventHandler(this.TextTool1_Click);

The Close event is called when the screen is closed.

The Controls Initialized event is called after the Initialize event has been fired on the screen and all other controls within.

The Custom Context Menu Action event is called when the custom context menu item is clicked. A Script event ID (configured for each custom context menu item in the Context Menu Items property for the screen or control) is passed in along with other relevant information in the context of the click, for example, facility or point tag, as appropriate.

Example

The following example shows how to use the Custom Context Menu Action event for the CygNet Grid. Substitute Grid1 with your control.

Canvas.Controls.Grid.CustomContextMenuActionEventArgs

When you click on a custom context menu item from a control, Canvas will execute the following function:

• Grid1_CustomContextMenuAction(object sender, EventArgs args)

CustomContextMenuActionEventArgs.EventActionID indicates the Script event ID defined in the Custom Context Menu Configuration dialog box.

1
2
3
4
5
6
private void Grid1_CustomContextMenuAction(object sender, EventArgs args)

{
    CustomContextMenuActionEventArgs myargs = (CustomContextMenuActionEventArgs)args;
    MessageBox.Show(myargs.MenuItemText + " " + myargs.EventActionID + " " + myargs.FacilityTag + " " + myargs.PointTag);
}

See Event Argument Type for more information about EventArgs.

The Data Load Completed event is called when all series have finished loading historical data.

The Double Click event is called when the user clicks twice on the Text Tool with the left mouse button.

Example

1
Objects.TextTool1.DoubleClick += new EventHandler(this.TextTool1_DoubleClick);

The Double Click Cell event is called when the user double-clicks on a grid cell.

Examples

1
var argument = args as Canvas.Controls.Grid.AlarmGridCellDoubleClickEventArgs;

1
var argument = args as Canvas.Controls.Grid.CygNetGridCellDoubleClickEventArgs;

See Event Argument Type for more information about EventArgs.

The Facility Changed event is called when the screen's facility is changed.

Example

1
var argument = args as Canvas.Shared.FacilityChangedEventArgs;

See Event Argument Type for more information about EventArgs.

The Initialize event is called when the screen is created in preview or run mode to allow further initialization of the control.

The Item Selected event is called when an item in the hierarchy is selected. This event only fires if the Selection action is Script.

The Key Down event is called when a key on the keyboard is pressed while this control has focus.

The following example shows how to use the Key Down event for the Enter key. Apply whatever actions you want to any key.

Example

1
2
3
4
5
6
7
8
9
10
11
12
#region EditBox
 
private void EditBox_KeyDown(object sender, EventArgs args)
{
    var key = (args as System.Windows.Input.KeyEventArgs).Key;
    if (key == System.Windows.Input.Key.Enter)
    {
        MessageBox.Show($"Text: {Objects.EditBox.Text}");
    }
}
 
#endregion

See Event Argument Type for more information about EventArgs.

The Key Up event is called when a key on the keyboard is released while this control has focus.

The following example shows how to use the Key Up event for the Enter key. Apply whatever actions you want to any key.

Example

1
2
3
4
5
6
7
8
9
10
11
12
#region EditBox
 
private void EditBox_KeyUp(object sender, EventArgs args)
    {
        var key = (args as System.Windows.Input.KeyEventArgs).Key;
        if (key == System.Windows.Input.Key.Enter)
        {
            MessageBox.Show($"Text: {Objects.EditBox.Text}");
        }
    }
 
#endregion

See Event Argument Type for more information about EventArgs.

The Live Update Changed event is called when a chart's live update setting changes. Can be used to allow interaction between charts and controls on a screen based on live updating behavior.

The Loaded event is called when the control is rendered and ready for interaction.

The Mouse Enter event is called when the mouse pointer enters (moves over) a control.

The Mouse Leave event is called when the mouse pointer leaves (moves out of) a control.

The Navigate By Facility event is called when the screen receives a request to navigate by a specific facility tag.

See Navigation by Facility for more information about using this event.

Example

1
var argument = args as Canvas.Shared.Events.NavigateByFacilityEventArgs;

See Event Argument Type for more information about EventArgs.

The Nested View Message Received event is called when a Nested View sends a message to its parent screen.

See To communicate between screens in a Nested View via script for more information about using this event.

Example

1
var argument = args as Canvas.Shared.NestedViewMessageEventArgs;

See Event Argument Type for more information about EventArgs.

The Opened Via Hyperlink event is called when 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.

Example

1
var argument = args as Canvas.Shared.OpenedViaHyperlinkEventArgs;

Related Links

• See Event Argument Type for more information about EventArgs

• See Hyperlinking Screens for more information about using this event

  See Navigation by Facility for information about how to navigate to a specific screen by selecting a CygNet facility

• See Navigation Button for information about adding a non-scripted hyperlink button to your screen.

The Pan Offset Changed event is called when a chart's pan offset values change. Can be used to allow interaction between charts and controls on a screen based on panning behavior.

The Point Configuration Changed event is called when a point's configuration changes.

The Point Value Changed event is called a point's value changes.

The Search Result Selected event is called when one of the search results is selected. This event only fires if the Selection action is Script.

See the following for more information:

• Facility search — To configure a Search Box to execute a scripted selection action
• Custom Search — Scripting Custom Searches

The Selected Cells Changed event is called when the grid cell selection changes.

Examples

1
var argument = args as Canvas.Controls.Grid.AlarmGridSelectionChangeEventArgs;

1
var argument = args as Canvas.Controls.Grid.CygNetGridSelectionChangeEventArgs;

See Event Argument Type for more information about EventArgs.

The Selection Changed event is called when the selection in the control changes or a new element is clicked.

Examples

1
var argument = args as Canvas.Controls.HeatMap.CanvasHeatMapSelectionChangedEventArgs;

1
var argument = args as Canvas.Controls.TreeMap.CanvasTreeMapSelectionChangedEventArgs;

See Event Argument Type for more information about EventArgs.

Notes

• The script property, SelectedItem, can be used with the Selection Changed event to return additional information about the item selected in the Combo Box.

• The script property, SelectedItem, can be used with the Selection Changed event to return additional information about the item selected in the Relative Facility Tree.

• Three script properties, SelectedItem, SelectedFacilities, and SelectedPoint, can be used with the SelectionChanged event to return additional information about the item selected in the Tag Chooser.

The Tab Selection Change event is called when the tab selection changes.

The Tooltip Opening event is called right before the tooltip opens creating a custom tooltip, which can show any desired information, for example, a value from an affiliated point, an unrelated data point, or even a CygNet note. The Tooltip mode (TooltipMode) property must be set to Script. The Tooltip Opening event supports multi-line tooltips.

Example

In the following example, a custom tooltip will be created that will retrieve and display three point values (Choke Position, SDV Valve Position, and Tubing Pressure) for the JOHNSON_WL facility on three separate lines.

1
2
3
4
5
6
7
8
9
10
11
12
13
private void TextTool1_TooltipOpening(object sender, EventArgs args)

    {
        CygNet.Data.Core.DomainSiteService Site = new CygNet.Data.Core.DomainSiteService(5410, "MYSITE", "UIS");
        CygNet.API.Points.RealtimeClient PointsClient = new CygNet.API.Points.RealtimeClient(Site);
        CygNet.Data.Core.PointTag Choke = new CygNet.Data.Core.PointTag("MYSITE.UIS:JOHNSON_WL_POACTCHO");
        CygNet.Data.Core.PointTag SDV = new CygNet.Data.Core.PointTag("MYSITE.UIS:JOHNSON_WL_POACTSDV");
        CygNet.Data.Core.PointTag Tubing = new CygNet.Data.Core.PointTag("MYSITE.UIS:JOHNSON_WL_PRTUBXIN");
        string TipValues = string.Concat("Choke Position: ", PointsClient.GetPointValueRecord(Choke).Value.ToString(), Environment.NewLine,
        "SDV Valve Position: ", PointsClient.GetPointValueRecord(SDV).Value.ToString(), Environment.NewLine,
        "Tubing Pressure: ", PointsClient.GetPointValueRecord(Tubing).Value.ToString());
        Objects.TextTool1.TooltipText = TipValues;
    }

See Event Argument Type for more information about EventArgs.

The Zoom Changed event is called when a chart's zoom values change. Can be used to allow interaction between charts and controls on a screen based on zooming behavior.