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 starting date of the FMS Exceptions control

This string can be in one of the following forms.

• Absolute date - for example: 1/31/2023
• 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.

See Selecting Date and Time for more information.

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, of the type specified by the ChooserFilterType property, when retrieving Nodes for selection

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_Category3_Device
• 2 – Node_Category3_Group
• 3 – Node_Category3_Station
• 6 – Node_Category3_Any
• 8 – Node_Category3_Gas_Device
• 9 – Node_Category3_Liquid_Device
• 13 – Node_Category3_Accessory

Default value is 6 - Node_Category3_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 control’s property page.

Returns/sets the XML specifying the columns that will appear on the FMS Exceptions 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 Exceptions Control for more information.

Returns/sets the format of the dates shown in the FMS Exceptions control

Possible values for this property are as follows.

• 0 – Device_Time
• 1 – Contract_Time
• 2 – Local_Time

Default value is 0 - Device_Time.

Returns/sets the ending date of the FMS Exceptions control

This string can be in one of the following forms.

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

Default value is T.

See Selecting Date and Time for more information.

Returns/sets the XML string specifying the exceptions "status" and "type" filter settings to use for data display in the FMS Configuration control

Filter property options for exceptions "status" are Open, Ignored, Resolved manually, and Resolved automatically.

Filter property options for exceptions "type" are Gas device, Gas station, Configuration log, Gas analysis, Liquid metering, Liquid configuration, and Job.

See Configure Filter in the Using the Exceptions Control topic for more information about available filter settings.

Possible values for these properties are as follows.

• 0 — No
• 1 — Yes

Default values for exception "status" are 1 - Yes for Open exceptions and 0 - No for all other exceptions status options.

Default values for exception "type" are 1 - Yes for all exceptions type options.

Another way to configure this property is to use the OCX Properties dialog box (click the Exceptions tab, then Filter).

Returns/sets the font used by the FMS Exceptions control

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

Default value is MS Shell Dlg.

Returns/sets the XML specifying the group hierarchy that will appear on the FMS Exceptions control

Another way to configure this property is to use the control’s property page.

Returns/sets the maximum number of Exceptions per Node that will be displayed in the FMS Exceptions control

Default value is 2000.

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

This string can be in one of the following forms.

• Absolute Date/Time - for example: 1/31/2023 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 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/2023
• Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

See Selecting Date and Time for more information.

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

Possible values for this property are as follows.

• 0 – Device_Time
• 1 – Contract_Time
• 2 – Local_Time

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/2023
• Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

See Selecting Date and Time for more information.

Returns/sets the Session Node tag, which specifies the active Node in the FMS Exceptions 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 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 the unit set used to determine the units of each data item in the FMS Exceptions control

Another way to configure this property is to use either the control’s property page or to use the Options page on the FMS Exceptions control.

Default value is the <Default> unit set.

Returns/sets whether or not to use the configured filter values (FilterConfigXml) to determine what data to display in the FMS Exceptions control

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 1 - Yes.

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 to use the SessionNodeTag property [if set to 1 - Yes] or to present a Chooser page for Node selection [if set to 0 - No] to specify the active Node in the control

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 0 - No for this control.