Alarm Grid Methods
The Alarm Grid supports the following scripting methods.
See Accessing Screen Objects for more information about how to view control objects in script in the Canvas application.
| Method | Description | |||
|---|---|---|---|---|
|
The AddRow method adds a row to the grid. It can include a facility tag. Example
|
||||
|
The AddRows method adds rows to the grid. It can take an enumerated list of facility tags. Example
|
||||
|
Equals |
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 Text. 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.
|
||||
|
The Focus method sets the focus to the control to allow further operations. |
||||
|
The GetCell method retrieves cell data from the grid. It returns a DataCell object. Example A DataCell object is in the following namespace:
A DataCell has one public method:
A DataCell has four public properties:
|
||||
|
The GetCellValue method retrieves cell values from the grid. Parameters include row and column. Returns a string value. Example
|
||||
|
The GetColumnDefinition method retrieves the specified column configuration for the grid column. |
||||
|
GetHashCode |
The GetHashCode method returns a hash code for the current object. |
|||
|
GetType |
The GetType method returns the runtime type of the current instance. |
|||
|
|
||||
|
|
||||
|
The Refresh method resets the cache and gets all data for the control from the associated service. |
||||
|
The ResolveRelativeFacility method returns the resolved relative facility. |
||||
|
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 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
|
||||
|
The SetRowFacility method sets the facility that will be used for the grid row. |
||||
|
The SetSiteServiceAndFilter method assists in modifying the SiteService and Filter properties without causing the control to duplicate work between each property change. |
||||
|
The ShowFacilityFilterDialog method opens the CygNet Facility Filter dialog box. |
||||
|
ToString |
The ToString method returns a string that represents the current object. |
|||
|
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 UseDefaultColumns method adds a set of 11 default column to the Alarm Grid. The default columns include: four Alarm columns (Alarm Priority, Alarm Acknowledge, Primary Value, Timestamp), and seven Point columns (Alarm Condition, SiteService, Long Point ID, Primary Units, Description, Facility ID, Uniform Data Code). See Column configuration for more information. |
