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 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)

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 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 type 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 record rows with exceptions will be shown in color to indicate problematic data

Possible values for this property are as follows.

• 0 - No
• 1 - Yes

Default value is 1 - Yes.

Returns/sets the grid color mode option used by the 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 control

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 whether a Station Meter Node (a Gas Meter Node set to also function as a station) will display station or device level data in the control [supersedes the deprecated MeterStationView property]

Possible values for this property are as follows.

• 1 – Device_Mode
• 3 – Station_Mode

Default value is 1 - Device_Mode.

Returns/sets the format of the dates shown in the 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 number of decimal places that will be shown in the values displayed by the control

Acceptable values include 0 - 10 decimal places.

Default value is 7.

Returns/sets the ending date of the data shown 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)

Default value is T.

See Selecting Date and Time for more information.

Returns/sets the font used by the control

Default value is MS Shell Dlg.

When a ColorGrid option other than "0 - None" is selected, returns/sets whether or not record cells triggering exceptions will be shown highlighted to indicate problematic data

Possible values for this property 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

Returns/sets the maximum data quality percentage below which results will be displayed in color in the control

Color will be applied to records in the control with lower data quality than this selected value, according to the color mode value defined by the ColorGrid property.

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 control as Stations or Devices

See DataMode for details.

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/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 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 control

Possible values for this property are as follows.

• 60 – Hourly
• 1440 – Daily
• 9999 – Native - appears for 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/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 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 control

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 control 

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

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 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 1 - Yes for this control.