System Projects Reference > The Library Controls Include Project > Use the Library Controls > Alarm Table Library Control | Library Control Include Project | Projects
Alarm Table Library Control

Alarm table genie has the following parameters:

Parameter

Description

Alarm Table Name

Name of table (max characters). Used to identify the genie when on a graphics page.

Width

Pixel width of the table at runtime.

Note: Leave the size of the genie at design time as 100 pixels, as it will be automatically calculated at runtime.

Number Of Rows

Number of rows displayed on the page.

Header Height

Pixel Height of header row in table display.

Row Height

Pixel height of row in the table display.

Header Padding

The pixel padding between the bottom of the header text (column name) and the bottom of the header row.

Row Padding

The pixel padding between the bottom of the cell text and the bottom of each row.

Column Padding

The pixel padding on the left-hand-side and right-hand-side of the cell text relative to the width of each column.

Refresh Rate

The minimum (quickest possible) rate that the control will be redrawn.

The control is only redrawn as required upon changes to the layout, scrolling or other user initiated events.

Scan Delay (Optional)

The number of page scan delay before the genie is initialized at runtime. this can be set to different number on different control genies to stagger the initialization order. If not set defaults to 1.

Last Alarm List

True/False drop down box. Determines whether the alarm list is a normal list (which will be instantiated via the function AlarmDsp) or a last alarm list (which will be instantiated via AlarmDspLast).

Horizontal Scrollbar (Optional)

The name of the horizontal scroll bar genie on the page that allows the user to horizontally scroll the content displayed on the control genie If you do not require horizontal scrolling, leave this field blank.

Vertical Scrollbar (Optional)

The name of the horizontal scroll bar genie on the page that allows the user to vertically scroll the content displayed on the control genie If you do not require vertical scrolling, leave this field blank.

Header Font

The pre-configured font for header text .

Auto Width

True/False drop down box. False is selected by default.

Format Category

The alarm category that is used to determine the fields (columns) displayed. If this is not specified, the columns displayed on the table will be determined by the field format defined in alarm category 0.

Cluster

The cluster of the alarm list If this is not specified, alarms from all clusters configured in the project will be displayed.

Allow Selection

True/False drop down. True is selected by default.

Alarm Type

The display type of the alarm list. See the Type parameter for the Cicode function AlarmDsp for details of the values you can use and what each represents.

Note: If you set the alarm type to a hardware alarm (types 5 - 9), the following limitations will apply:

  • The format used to display the hardware alarms will be defined by the Alarm Format property for alarm category 255.
  • You may need to specify off-screen animation numbers (ANs) for each table row. If you are using a Citect SCADA template project (StruxureWare or Tab Style templates), a set of ANs starting at 21 is already reserved for this purpose. If you are not using a template project, you will need to manually add these ANs.

AN

The Animation Number (AN) of a user created Cicode / Animation Number object where the alarm list will be instantiated (displayed). If this is less than 1, the alarm list will be displayed at a random AN. The AN allows the user to interact with the alarm list at runtime using built-in Cicode functions such as AlarmSetInfo(), AlarmDspPrev() and AlarmDspNext().

Intialize (Optional)

Callback function that is called when the control initializes. The callback function should return either TRUE (1) for success or FALSE (0) if unsuccessful. By default, if the user specified function does not initialize, the control genie will retry the function a few times before giving up. This callback only supports the #Name keyword which represents the name assigned to the control genie.
Note: The initialization callback function may be called multiple times whenever the table is re-initialized.

Left Mouse (Optional)

Callback function that is called when the user clicks the left mouse button No particular return value is expected from this function, and it supports the following keywords in its argument list:

#Name = name assigned to the genie

#Row = row number of the cell (with respect to the underlying data) that is clicked

#Col = column number of the cell that is clicked

#RowDsp = row number of the cell relative to the display that is clicked

#ColDsp = column number of the cell relative to the display that is clicked

#AN= the animation number where the alarm is displayed

Right Mouse (Optional)

Callback function that is called when the user clicks the right mouse button It uses the same specification as that of the Left mouse callback .

Double Click (Optional)

Callback function that is called when the user double-click the left mouse button It uses the same specification as that of the Left mouse callback.

Table Reload (Optional)

Callback function that is called when the control is redrawn No particular return value is expected from this function, and it supports the following keywords in its argument list:

#Name = name assigned to the genie

Note: The table can be up to 62 columns (although the latter columns may not have the column separators). For tables that return more columns than the limit, the first 62 columns will be displayed.

See Also

Published June 2018