CxFmsAlarmLogCtrl Properties
The CxFmsAlarmLogCtrl object contains the following properties.
General Properties
Browse by letter: A B C D E F I P S U
| Property | SubType | Read Only | Description |
|---|---|---|---|
|
Integer |
No |
Returns/sets the alarm record source filter Possible values for this property are as follows.
Default value is 255 — Any alarms |
|
|
Integer |
No |
Returns/sets the appearance of the object boundary Possible values for this property are as follows.
Default value is 0 — Flat |
|
|
String |
No |
Note: This property is only used if the UseSessionOptions property is set to 0 - No. Returns/sets the starting date of the FMS Alarm control This string can be in one of the following forms.
Default value is T-7 |
|
|
Integer |
No |
Returns/sets the border style Possible values for this property are as follows.
Default value is 0 — None |
|
|
String |
No |
Returns/sets the filter to be used when retrieving Nodes Wildcard values * (multiple character) and ? (single character) are supported. Wildcards can be used in any part of the string to specify that any character or set of characters is allowed in its place. Example A filter string of "*Test*" will retrieve all Nodes with the word "Test" somewhere in the string, such as "TestDevice" or "MyTestDevice" or "Device001Test". Default value is * (multiple character wildcard) |
|
|
Integer |
No |
Returns/sets the Node property that will be filtered by the string specified in the ChooserFilterString property Possible values for this property are as follows.
Default value is 0 — Name |
|
|
String |
No |
Returns/sets the group currently selected in the Node chooser’s Group combo box |
|
|
Integer |
No |
Returns/sets the primary sort column of the Node chooser’s Node list Possible values for this property are as follows.
Default value is 2 — Name ascending |
|
|
String |
No |
Returns/sets the Site.Service currently selected in the Node chooser’s FMS combo box |
|
|
Boolean |
No |
Returns/sets whether or not the Node chooser’s FMS combo box is visible Possible values for this property are as follows.
Default value is 1 — Yes |
|
|
String |
No |
Returns/sets the XML specifying the custom FMS commands configured for the control Another way to configure this property is to use the control’s property page. |
|
|
Integer |
No |
Note: This property is only used if the UseSessionOptions property is set to 0 - No. Returns/sets the format of the dates shown in the FMS Alarm control Possible values for this property are as follows.
Default value is 0 — Device time |
|
|
String |
No |
Note: This property is only used if the UseSessionOptions property is set to 0 - No. Returns/sets the ending date of the FMS Alarm control This string can be in one of the following forms.
Default value is T |
|
|
String |
No |
Returns/sets the XML specifying the filter for the data that will be displayed in the FMS Alarm control Another way to configure this property is to use the CygNet FMS Alarm Control Properties dialog box ((OCXProperties) > Alarm Log page, then Log source). See Configure Filter in the Using the Alarm Control topic for more information about the filter settings. |
|
|
StdFont |
No |
Returns/sets the font used by the FMS Alarm control Click … to access the Font dialog box to make font selections. Default value is MS Shell Dlg. |
|
|
Boolean |
Yes |
Returns whether or not the user is currently editing data in the FMS Alarm control |
|
|
String |
No |
Note: This property is only used if the UsePIT property is set to 1 - Yes. Returns/sets the Point in Time date and time of the FMS Alarm control This string can be in one of the following forms.
Default value is T, date and time today. See Using the Home Menu for more information about PIT mode. |
|
|
String |
No |
Note: This property is only used if the UseSessionOptions property is set to 1 - Yes. Returns/sets the Session starting date for the time window displayed in the control. This string can be in one of the following forms.
Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control. |
|
|
Integer |
No |
Note: This property is only used if the UseSessionOptions property is set to 1 - Yes. Returns/sets the Session date/time format for the time window displayed in the control Possible values for this property are as follows.
Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control. |
|
|
String |
No |
Note: This property is only used if the UseSessionOptions property is set to 1 - Yes. Returns/sets the Session ending date for the time window displayed in the control This string can be in one of the following forms.
Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control. |
|
|
String |
No |
Note: This property is only used if the UseSessionNode property is set to 1 - Yes. Returns/sets the Session Node tag, which specifies the active Node in the FMS Alarm control This tag must be in the form SITE.SERVICE|ID (for example, TEST.FMS|2540). Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control. |
|
|
OLE_COLOR |
No |
Returns/sets the color of the cells in the FMS Alarm control See Shading Colors for more information about this property. Default value is 255.250.205 (pale yellow) |
|
|
OLE_COLOR |
No |
Returns/sets the color of the text in the FMS Alarm control See Shading Colors for more information about this property. Default value is 0.0.0 (black) |
|
|
Boolean |
No |
Returns/sets whether or not the Chooser pane will be displayed in the control Possible values for this property are as follows.
Default value is 1 - Yes |
|
|
Boolean |
No |
Returns/sets whether or not the Options pane will be displayed in the control Possible values for this property are as follows.
Default value is 1 - Yes |
|
|
Integer |
No |
Returns/sets which parts of the grid will be shaded with color Possible values for this property are as follows.
See Shading Colors for more information about this property. Default value is 3 — Both |
|
|
Boolean |
No |
Returns/sets whether or not to use the configured filter values (FilterConfigXml) to determine what data to display in the control Possible values for this property are as follows.
Default value is 0 - No |
|
|
Boolean |
No |
Returns/sets whether or not the PITDateTime property will be used Possible values for this property are as follows.
Default value is 0 — No |
|
|
Boolean |
No |
Returns/sets whether or not the SessionNodeTag property will specify the active Node in the FMS Alarm control If this property is set to 0 - No, the FMS Alarm control will present a Chooser page for selection of the active Node. Possible values for this property are as follows.
Default value is 1 — Yes |
|
|
Boolean |
No |
Returns/sets whether or not the SessionBeginDate, SessionEndDate, and SessionDateFormat properties will be used in place of the BeginDate, EndDate, and DateFormat properties. Possible values for this property are as follows.
Default value is 1 — Yes |


