CxFmsBalanceCtrl Properties

Important:

This topic has been updated to include additional functionality provided subsequent to the CygNet Software v9.6 release by "Required" FMS patches available in the 96_Patch_Composite.zip via the CygNet Software download site.

These Help documents assume installation of required patches.

Visit the Weatherford software support portal (login required), and access the CygNet Software Download Website to obtain and install required patch files and update your CygNet Measurement system to access the new features (from the support portal select CygNet Software > CygNet Software Download Site [login] > Software > SCADA and Measurement Products > 9.6 > Patches > 96_Patch_Composite.zip). See CygNet Software Downloads for additional access information.

The CxFmsBalanceCtrl object contains the following properties.

Note: Time format selection is not available in this control. The Balance control displays data in Contract time (C), with one exception. The Last Modified column displays the timestamp of the last modification in Local time (L).

General Properties

PropertySubTypeRead OnlyDescription

Appearance

Integer

No

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

BeginDate

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

BorderStyle

Integer

No

Returns/sets the border style

Possible values for this property are as follows.

  • 0 - None
  • 1 - Fixed Single

Default value is 0 - None

ChooserFilterString

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)

ChooserFilterType

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.

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

Default value is 0 - Name

ChooserGroupSelection

String

No

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

Default value is All Nodes

ChooserPrimarySortColumn

Integer

No

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

ChooserSiteServiceSelection

String

No

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

ChooserSiteServiceVisible

Boolean

No

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

CmdDefinitionXml

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.

Columns

String

No

Returns/sets the XML specifying the columns that will be displayed in the FMS Balance control

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

DataQualityColorXml

String

No

Returns/sets the XML specifying the accumulated color settings for the FMS Balance control

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

DateTimeDisplayMode

Integer

No

Returns/sets whether dates displayed in the FMS Balance 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

EndDate

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

Font

StdFont

No

Returns/sets the font used by the FMS Balance control

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

Default value is MS Shell Dlg.

PITDateTime

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 Balance 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.

SessionBeginDate

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.

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

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.

SessionEndDate

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.

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

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.

SessionNodeTag

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 Balance 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.

ShowChooserPane

Boolean

No

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

ShowHourly

Boolean

No

Returns/sets whether or not to show hourly records in the control, in addition to daily and monthly rollups

Options are as follows.

  • 0 - No
  • 1 - Yes

0 - No means only daily and monthly rollups will be shown; 1 - Yes means hourly records will also be shown.

Default value is 1 - Yes

ShowOptionsPane

Boolean

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

UnitSet

String

No

Returns/sets the unit set used to determine the units of each FMS data item in the FMS Balance 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 Balance control.

Default value is the <Default> unit set

UsePIT

Boolean

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

UseSessionNode

Boolean

No

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

If this property is set to 0 - No, the FMS Balance 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

UseSessionOptions

Boolean

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

Back to top