Returns/sets the appearance of the object boundary

Possible values for this property are as follows.

• 0 – Flat
• 1 – 3D

Default value is 0 - Flat

Returns/sets the XML specifying the colors and cell values that will appear on the FMS Dashboard control

Another way to configure this property is to use the CygNet FMS Dashboard Control Properties dialog box ((OCXProperties) > Dashboard page, then Display properties).

See Configuring Dashboard Display Properties for more information about display settings.

Returns/sets the starting date of the FMS Dashboard control

This string can be in one of the following forms.

• Absolute date - for example: 1/31/2022
• Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Default value is T-7

Returns/sets the border style

Possible values for this property are as follows.

• 0 - None
• 1 - Fixed single border

Default value is 0 - None

Returns/sets whether or not the user can select multiple Nodes in the Node chooser

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 1 - Yes

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)

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.

• 0 – Name
• 1 – Description
• 2 – ID

Default value is 0 - Name

Returns/sets the group currently selected in the Node chooser’s Group combo box

Returns/sets the Node category currently selected in the Node chooser’s Node category combo box

Possible values for this property are as follows.

• 1 - Node_Category1_Device
• 2 – Node_Category1_Group
• 3 – Node_Category1_Station
• 6 - Node_Category1_Any
• 8 – Node_Category1_Gas_Device
• 9 - Node_Category1_Liquid_Device

Default value is 6 - Node_Category1_Any

Returns/sets whether or not the Node chooser’s Node category combo box is visible

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 1 - Yes

Returns/sets the primary sort column of the Node chooser’s Node list

Possible values for this property are as follows.

• 0 - Type ascending
• 2 - Name ascending
• 3 - Description ascending
• 4 - Type descending
• 5 - Name descending
• 6 - Description descending

Default value is 2 - Name ascending

Returns/sets the Site.Service currently selected in the Node chooser’s FMS combo box

Returns/sets whether or not the Node chooser’s FMS combo box is visible

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 1 - Yes

Returns/sets the XML specifying the custom FMS commands configured for the control

Another way to configure this property is to use the CygNet FMS Dashboard Control Properties dialog box ((OCXProperties) > Command page).

Returns/sets the XML specifying the columns that will appear on the FMS Dashboard control

Another way to configure this property is to use the control-specific property page in the CygNet FMS Control Properties dialog box. See CygNet FMS Dashboard Control for more information.

Returns/sets the update interval, in number of seconds, for the custom data columns, as configured in the Admin Options, if displayed in the Dashboard control

See Using the Dashboard Control for more information.

Returns/sets the data mode for viewing summary data

Possible values for this property are as follows.

• 1 – Device_Mode
• 3 – Station_Mode

Default value is 1 - Device_Mode

Returns/sets whether dates displayed in the FMS Dashboard control will have the time appear before the date (leading) or after the date (trailing)

Possible values for this property are as follows.

• 0 – LeadingTime
• 1 – TrailingTime

Default value is 0 - LeadingTime

Returns/sets the ending date of the FMS Dashboard control

This string can be in one of the following forms.

• Absolute date - for example: 1/31/2022
• Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Default value is T

Returns/sets the XML specifying the filter for the data that will be displayed in the FMS Dashboard control

Another way to configure this property is to use the CygNet FMS Dashboard Control Properties dialog box ((OCXProperties) > Dashboard page, then Filter).

See Configuring Dashboard Filters for more information about the filter settings.

Returns/sets the font used by the FMS Dashboard control

Click … to access the Font dialog box to make font selections.

Default value is MS Shell Dlg.

Returns/sets the Point in Time date and time of the FMS Dashboard control

This string can be in one of the following forms.

• Absolute Date/Time - for example: 1/31/2022 7:10:14 AM
• Relative Date/Time - for example: y-1 m-2 d=15 H=5 M=30 S=0
• Relative Day - an offset from the current day T, for example: T-10

Default value is T, date and time today.

See Using the Home Menu for more information about PIT mode.

Returns/sets the order in which records will be displayed in the FMS Dashboard

Possible values for this property are as follows.

• 0 - Oldest _First
• 1 - Newest_First

Default value is 0 - Oldest_First

Returns/sets selection behavior for setting the Session Node in the control

Possible values for this property are as follows.

• 0 - SingleClick
• 1 - DoubleClick

Default value is 1 - DoubleClick

Returns/sets the Session starting date for the time window displayed in the control

This string can be in one of the following forms.

• Absolute date - for example: 1/31/2022
• Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Returns/sets the Session ending date for the time window displayed in the control

This string can be in one of the following forms.

• Absolute date - for example: 1/31/2022
• Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Returns/sets the Session Node tag, which specifies the active Node in the FMS Configuration control

This tag must be in the form SITE.SERVICE|ID (for example, TEST.FMS|2540).

Returns/sets whether or not the Chooser pane will be displayed in the control

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 1 - Yes

Returns/sets whether to show custom columns, as configured in the Admin Options (Custom Dashboard Columns page), in the CygNet FMS Dashboard Control

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 0 - No

Returns/sets whether or not the FMS Dashboard control will display a fixed column showing the number of exceptions for a Node

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 1 - Yes

Returns/sets whether or not the FMS Dashboard control will display a fixed column showing the Node description

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 1 - Yes

Returns/sets whether or not the FMS Dashboard control will display a fixed column showing the Node priority

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 0 - No

Returns/sets whether or not the Options pane will be displayed in the control

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 1 - Yes

Returns/sets whether or not the FMS Dashboard control will display a fixed column showing the percentage of missing data for a Node

"Missing data" means records with a collection status of anything other than Good or Partial.

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 1 - Yes

Returns/sets whether or not the FMS Dashboard control will display the Use filter button in the control

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 1 - Yes

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.

• 0 - No
• 1 - Yes

Default value is 0 - No

Returns/sets whether or not the PITDateTime property will be used

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 0 - No

Returns/sets whether or not the SessionNodeTag property will specify the active Node in the FMS Dashboard control

If this property is set to 0 - No, the FMS Dashboard control will present a Chooser page for selection of the active Node.

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 0 - No

Returns/sets whether or not the SessionBeginDate and SessionEndDate properties will be used in place of the BeginDate and EndDate properties

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 0 - No