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 History Grid

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 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_Category2_Device
• 3 – Node_Category2_Station
• 8 – Node_Category2_Gas_Device
• 9 – Node_Category2_Liquid_Device

Default value is 8 - Node_Category2_Gas_Device

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.

When a ColorGrid option other than "0 - None" is selected, returns/sets whether or not records with exceptions will be shown in red to indicate bad data

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 1 - Yes

Returns/sets the color option used by the FMS History Grid control

Possible values for this property are as follows.

• 0 - None
• 1 - Row background
• 2 - Row text
• 3 - Date/Time background
• 4 - Date/Time text

Default value is 1 - Row background

Returns/sets the XML specifying the columns that will be displayed in the FMS History Grid

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

Returns/sets the format of the dates shown in the FMS History Grid

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 number of decimal places that will be shown in the values displayed by the FMS History Grid

Acceptable values include 0 - 10 decimal places.

Default value is 7

Returns/sets the ending date of the FMS History Grid

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 font used by the FMS History Grid control

Default value is MS Shell Dlg.

When a ColorGrid option other than "0 - None" is selected, returns/sets whether or not to highlight record cells that contain data triggering exceptions in the FMS History Grid control

Options are as follows.

• 0 - No
• 1 - Yes

Default value is 1 - Yes

Returns whether or not the user is currently editing data in the FMS History Grid control

When a ColorGrid option other than "0 - None" is selected, returns/sets the data quality value below which color will be applied in the FMS History Grid

Possible values for this property are as configured in your system, via the Admin menu. See Configuring Data Quality Settings for more information.

Returns/sets whether Station Meters will be displayed in the FMS History Grid as Stations or Devices

Possible values for this property are as follows.

• 3 – Stations_Mode
• 8 – Gas_Devices_Mode

Default value is 8 - Gas_Devices_Mode

Returns/sets the Point in Time date and time of the FMS History Grid 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, which is 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 History Grid

Possible values for this property are as follows.

• 0 - Oldest _First
• 1 - Newest_First

Default value is 0 - Oldest_First

Return/sets the span of each record displayed in the FMS History Grid

Possible values for this property are as follows.

• 60 – Hourly
• 1440 – Daily
• 9999 – Native (Device data view only; not applicable to Station data view)

Default value is 9999 - Native for Device data view, 60 - Hourly for Station data view

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 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/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 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 units will be displayed in the FMS History Grid

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 0 - No

Returns/sets the unit set used to determine the units of each FMS data item in the FMS History Grid

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

Default value is the <Default> unit set

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 History Grid

If this property is set to 0 - No, the FMS History Grid 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 1 - Yes