List Row Genie
- Last UpdatedJul 18, 2023
- 2 minute read
Genie Name: list_row_x<n>
Genie Library: sa_controls
System Project: SA_Controls
The List Row Genie can be used in conjunction with the Alarm List Genie and Generic List Genie Genies to facilitate row selection, row context menu and row background color. Several variations of the List Row Genie are available:
-
List Row x5 – use this to create a list with up to 5 rows.
-
List Row x10 – use this to create a list with up to 10 rows.
-
List Row x40 – use this to create a list with up to 40 rows.
-
List Row x80 – use this to create a list with up to 80 rows.
Note: There is no need to adjust the size of the List Row Genie on a graphics page to fill an area. The required space will be determined at runtime by the size of the list with which it is associated.
For further instructions on how to use the List Row Genie, see Add an Alarms List to a Page or Add a Generic List to a Page.
List Row Genie Properties
Complete the following properties for the Genie in the Genie Properties dialog box.
-
AN: This is an automatically-generated unique ID for the Genie object.
-
Name: Optional. If you need to reference the Genie at runtime using Cicode, specify a unique name.
List Row Genie Parameters
Select the Genie and double-click on it to view its parameters. The parameters are used as described in the table below:
|
Parameter |
Description |
|---|---|
|
ArrayAN |
Specify the AN of the alarm list to which row formatting will be applied. You can use the Cicode function DspGetAnFromName to retrieve the AN. For example, DspGetAnFromName("AlarmList"). |
|
RowOffset |
Row number at which to display a list if there are multiple Alarm List Genies on the page. Default is 0. If multiple List Row Genies are inserted on to a page, you need to specify the correct row offset for each List Row Genie. For example, if you insert two List Row_x10 Genies, the row offset for the first Genie will be 0 while the row offset for the second Genie will be 10. |
|
LeftClickCommand |
Allows you to call Cicode that performs operations when you click on a row within the list. For example, you can select the row using AlarmPage_SelectAlarmRecord(DspGetAnFromName("AlarmList")). |
|
RightClickCommand |
Allows you to call Cicode that performs operations when you right-click on a row within the list. For example, Alarm_TopAlarmsRow_RightClickCommand(DspGetAnFromName("AlarmList")). |