The AcknowledgeAlarm method acknowledges an alarm.

The Add method adds an item to the Combo Box along with an associated value.

The AddControl method dynamically adds a control to a screen object at runtime.

See Adding a Control Via Script for more information about using this method.

The AddFacility method dynamically adds a facility to the control runtime.

Map —

The AddLayer method dynamically adds a layer to a map at runtime.

Screen/Object —

The AddLayer method dynamically adds a layer to a screen object at runtime.

Example

The script call is as follows:

1
bjects.Screen.AddLayer("Layer 1");

where "Layer 1" is the layer name.

See Scripting Layers for more information about using this method.

The AddRow method adds a row to the grid. It can include a facility tag.

Example

1
2
3
public void AddRow()

public void AddRow(FacilityTag facility)

The AddRows method adds rows to the grid. It can take an enumerated list of facility tags.

Example

1
public void AddRows(IEnumerable<FacilityTag> facilities)

The AddSeries method adds a series to the chart via script. See Scripting a Chart Series for more information.

The AddTab method adds a tab to the Tab control.

The ChangeScreen method swaps one screen for another in the Nested View.

The CloseScreen method closes a screen.

The DeleteSeries method removes a series from a chart via script.

The Dispose method releases unmanaged resources used by the application.

The Equals method determines whether the specified object is equal to the current object.

The Export method exports data from a grid column, including its summary row, if configured. Supported formats include .csv, .html, and .txt. Export from historical columns is not supported.

Example

The following example uses a button click event and Edit Box to provide a path to export to.

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
Objects.CsvExportButton.Click += new EventHandler(this.CsvExportButton_Click);
Objects.HtmlExportButton.Click += new EventHandler(this.HtmlExportButton_Click);
Objects.TextExportButton.Click += new EventHandler(this.TextExportButton_Click);
Objects.EditBox1.Initialize += new EventHandler(this.EditBox1_Initialize);
 
private void EditBox1_Initialize(object sender, EventArgs args)
{
    Objects.EditBox1.Text = @"E:\temp\GridExport";
}
 
private void CsvExportButton_Click(object sender, EventArgs args)
{
    Objects.CygNetGrid1.Export(Objects.EditBox1.Text + ".csv", Canvas.Controls.Grid.GridExportFormat.Csv,true);
}
 
private void HtmlExportButton_Click(object sender, EventArgs args)
{
    Objects.CygNetGrid1.Export(Objects.EditBox1.Text + ".html",Canvas.Controls.Grid.GridExportFormat.Html,
true);
}
 
private void TextExportButton_Click(object sender, EventArgs args)
{
    Objects.CygNetGrid1.Export(Objects.EditBox1.Text + ".txt",Canvas.Controls.Grid.GridExportFormat.Text,true);
}

The ExportCsv method exports data from a Note Grid in run mode in .csv format.

The ExportToImageFile method exports the chart to an image file.

The Flip method flips the Detail control when clicked to display a Canvas object of your choosing on the reverse side of the control.

The Focus method sets the focus to the control to allow further operations.

The GetAllScreenControls method retrieves all objects on a screen allowing programmatic interaction with all controls on a screen.

The GetCell method retrieves cell data from the grid. It returns a DataCell object.

Example

A DataCell object is in the following namespace:

1
public Canvas.Controls.Grid.CygNetGrid.DataCell GetCell(int row, int column)

A DataCell has one public method:

1
public virtual CygNet.Data.Core.FacilityTag GetAssociatedFacilityTag()

A DataCell has four public properties:

1
2
3
4
5
6
7
public CygNet.Data.Alarms.CygNetAlarmProperties.CygNetAlarmProperty AlarmDisplayProperty { get; }

public System.Windows.Media.Brush BackgroundColor { get; set; }

public CygNet.Data.Core.CygNetCoreProperties.CygNetProperty CoreDisplayProperty { get; }

public virtual object Value { get; set; }

The GetCellValue method retrieves cell values from the grid. Parameters include row and column. Returns a string value.

Example

1
public string GetCellValue(int row, int column)

The GetColumnDefinition method retrieves the specified column configuration for the grid column.

The GetData method returns data in a specified data format.

The GetGlobalDictionary method returns the dictionary itself, allowing a script writer to manipulate the dictionary directly or inspect its contents.

Example

1
public Canvas.Shared.CanvasGlobalDictionary GetGlobalDictionary()

The Canvas.Shared class, "CanvasGlobalDictionary," is a C# System.Collections.Generic.Dictionary<string, object>. The string represents the key and the object represents the value. This collection allows you to store any data you want and reference it later by the key assigned when it was added. If the same key is used multiple times, the original value would be replaced by the latest update.

See Global Dictionary for more information about using this method.

The GetHashCode method returns a hash code for the current object.

The GetLayer method retrieves the specified layer from the map configuration.

The GetSparklineData method returns data in a specified data format.

The GetType method returns the runtime type of the current instance.

The HideLayer method dynamically hides a layer on a screen object at runtime.

Example

The script call is as follows:

1
Objects.Screen.HideLayer("Layer 1");

where "Layer 1" is the layer name.

See Scripting Layers for more information about using this method.

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.

See Hyperlinking Screens for more information about using this method.

The HyperlinkReplace method replaces the active screen in the control with a facility's associated screen.

See Hyperlinking Screens and Navigation by Facility for more information about using this method.

The HyperlinkReplaceWithNavigation method replaces the active screen in the control with a facility's associated screen and adds a navigation toolbar.

See Hyperlinking Screens and Navigation by Facility for more information about using this method.

The IsDataLoaded method is a Boolean function used to determine whether all series have finished loading historical data.

The IsOrderInTypeConfiguredForDefinition method checks to see if an order in type (facility ordinal) is configured for the selected relative facility definition.

The IsScreenOpen method checks to see if a screen is open in that instance of Canvas or Canvas.View. This method is case-insensitive.

The NavigateToScreenByFacility method is included on the screen object and allows you to navigate to a specific screen by selecting a CygNet facility.

Example

The script call is as follows:

1
Objects.Screen.NavigateToScreenByFacility(facility);

The correlation between a facility and its associated screen is done via a facility attribute. You will need to configure the facility attribute that references the associated screen in your CygNet system for each facility using CygNet Explorer.

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

The ReadFromGlobalDictionary method reads a complex script object from another screen.

See Global Dictionary for more information about using this method.

The Refresh method resets the cache and gets all data for the control from the associated service.

The RefreshChart method refreshes the data in the chart from the Value History Service (VHS).

The RefreshTagChooser method is used to trigger a data refresh at any time or after delayed loading.

Example

The following example code snippet sets a button (Button1) such that on click it’s going to load the TagChooser1.

1
2
3
4
5
6
7
8
9
10
11
12
public ScreenClass()
{
    // control event handler code goes here -- do not modify
    Objects.Button1.Click += new EventHandler(this.Button1_Click);
    // add your custom initialization code here
}

private void Button1_Click(object sender, EventArgs args)
{
    Objects.TagChooser1.DelayLoading = false;
    Objects.TagChooser1.RefreshTagChooser();
}

The Remove method removes an item from the Combo Box.

The RemoveAll method removes all items from the Combo Box.

The RemoveControl method dynamically removes a control to a screen object at runtime.

See Adding a Control Via Script for more information about using this method.

The ResetMouseCursor method resets the mouse cursor setting for the screen.

The ResolveRelativeFacility method returns the resolved relative facility.

The ReturnToStartScreen method returns the Navigator menu to the start screen.

Combo Box —

The Select method is available to select an item in the control via script.

Navigator —

The Select method takes in a NavigationItem as a parameter and sets the ActiveItem property to that item and does not return any value. Select allows you to provide navigation items that do not exist in the navigation menu. This is how you select navigation items via script.

The Select All method allows multi-row selection via script. If the SelectionMode property is Multiple or Extended, SelectAll will select all rows in a grid and the SelectedRows property will return the matching DataRow objects. SelectAll will not obviously change the selection if SelectionMode is Single.

The SelectTab method takes an integer and allows selection of items in the Tab control. This is how you select tabs via script.

The SendFacilityBroadcast method broadcasts a facility to any open screen set to receive the facility.

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

Use the SendMessage method on any nested screen to pass in a message to another nested screen. In addition to messages, you can also send and receive objects which can be used to manipulate the receiving screen, including:

• the sending parent or child screen itself
• message arguments that allow access to all controls and properties in the receiving screen
• controls (for example, a grid or button)
• data structures
• lists

See To communicate between screens in a Nested View via script for more information.

The SendMessageBroadcast method broadcasts a message to any open screen set to receive the broadcast.

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

The SendParentMessage method sends a message from a child screen to a parent screen.

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

The SendSiteServiceBroadcast method broadcasts a SiteService to any open screen set to receive the SiteService.

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

The SetCellValue method can be used to add custom data to the grid. Parameters include row, column, and string value. Returns a Boolean value to indicate success or failure.

Example

1
public bool SetCellValue(int row, int column, string value)

The SetFacilities method sets the list of facilities to be displayed in the control.

The SetFacilityList method sets the list of facilities that will be used to instantiate objects in the container.

The SetImage method sets the dynamic image to use on the image control.

The SetLayerVisibility method dynamically shows or hides a layer on a screen object at runtime.

Example

The script call is as follows:

1
2
3
Objects.Screen.SetLayerVisibility("Layer 1", false);
 
Objects.Screen.SetLayerVisibility("Layer 1", true);

where "Layer 1" is the layer name.

See Scripting Layers for more information about using this method.

The SetLowerAndUpperValue method sets the lower value bound and the upper value bound via script.

The SetLowerBoundValue method sets the lower value bound via script.

The SetMissingImage method sets the image to display if no image is configured.

The SetMouseCursor method sets the mouse cursor setting for the screen.

The SetParentFacility method sets the parent facility that will be used (along with the facility filter) to instantiate objects.

The SetRowFacility method sets the facility that will be used for the grid row.

The SetServiceFilter method sets the filter (for a facility attribute-based Tag Chooser) to only show facilities from the provided Current Value Services.

The SetSiteServiceAndFilter method assists in modifying the SiteService and Filter properties without causing the control to duplicate work between each property change.

The SetUpperBoundValue method sets the upper value bound via script.

The ShowFacilityFilterDialog method opens the CygNet Facility Filter dialog box.

The ShowLayer method dynamically shows a layer on a screen object at runtime.

Example

The script call is as follows:

1
Objects.Screen.ShowLayer("Layer 1");

where "Layer 1" is the layer name.

The ShowPopup method creates a popup at the mouse location containing an object specified in the parameters. The path can be either a Canvas screen file (.can) or Canvas object file (.cob).

Example

The script call is as follows:

1
2
3
4
5
passtring path = @"CYGDEMO.BSSCAN\DEMO\Main.can";
Canvas.Helpers.CanvasFileSource source = Canvas.Helpers.CanvasFileSource.BSS;
CygNet.Data.Core.FacilityTag facilityTag = new CygNet.Data.Core.FacilityTag("CYGDEMO.UIS::ASH_WL");
 
Objects.Screen.ShowPopup(path, source, facilityTag);te

The StartSparkline method starts the line in the Sparkline control.

The ToString method returns a string that represents the current object.

The UpdateDetailsControls method updates the tiled Details controls displayed on the Tile View control.

The UpdateFacilityTagListFilter method changes the facility filter of the grid. The method ensures that the FacilitySource property is <Self>, updates the FacilityTagListFilter property, and then calls on the Refresh method.

The UpdateMainScreenFacility method updates the facility used for the main screen. The main screen is the Canvas screen that will be displayed when you maximize the tile and display a screen at the top of the Tile View when in run mode.

The UpdateRangeAbsolute helper method updates chart data for an absolute date range.

The UpdateRangeRelative helper method updates chart data for a relative date range.