CxFmsRawDeviceDataCtrl Properties

The CxFmsRawDeviceDataCtrl object contains the following properties.

General Properties

Browse by letter:     [A]     [B]     [C]     [D]     [E]     [F]     [P]     [S]     [U]    

Property SubType Read Only Description

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 Raw Data 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.

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.

BorderStyle

Integer

No

Returns/sets the border style

Possible values for this property are as follows.

  • 0 - None
  • 1 - Fixed single border

Default value is 0 - None.

ChooserFilterString

String

No

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

ChooserFilterType

Integer

No

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.

ChooserGroupSelection

String

No

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

ChooserNodeCategorySelection

Integer

No

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_Category5_Device
  • 8 – Node_Category5_Gas_Device
  • 9 – Node_Category5_Liquid_Device

Default value is 1 - Node_Category5_Device.

ChooserNodeCategoryVisible

Boolean

No

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.

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.

ColumnsXml

String

No

Returns/sets the XML specifying the columns that will be displayed in the FMS Raw Data 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 Raw Data Control for more information.

DataView

Integer

No

Returns/sets the "Data view" option that will be displayed in the FMS Raw Data control [supersedes the deprecated DisplayMode property]

Possible values for this property are as follows.

  • 1 – AlarmEntry
  • 11 – ConfigLogRaw
  • 20 – EventEntry
  • 25 – MeteringRaw
  • 27 – GasQualityRaw
  • 57 – BatchRaw
  • 112 – TicketRaw

Default value is 1 - AlarmEntry.

DateFormat

Integer

No

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Returns/sets the format of the dates shown in the FMS Raw Data control

Possible values for this property are as follows.

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

Default value is 0 - Device_Time .

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.

DecimalPrecision

Integer

No

Returns/sets the number of decimal places that will be shown in the values displayed by the FMS Raw Data control

Acceptable values include 0 - 10 decimal places.

Default value is 7.

DisplayMode

Integer

No
Note: This property deprecated in favor of DataView

Returns/sets the "Data view" option that will be displayed in the FMS Raw Data control

See DataView for details.

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 Raw Data 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.

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.

Font

StdFont

No

Returns/sets the font used by the FMS Raw Data 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 Raw Device Data 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.

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

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.

SessionDateFormat

Integer

No

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

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

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

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 Raw Data 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.

ShowMostRecentRecords

Boolean

No

Returns/sets whether or not to show only the most recent record for each hour in the control

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

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.

ShowUnits

Boolean

No

Returns/sets whether or not units will be displayed in the FMS Raw Data control

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 0 - No.

UnitSet

String

No

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

Note: Default value varies by control type.

UseSessionOptions

Boolean

No

Returns/sets whether to use the SessionBeginDate, SessionEndDate, and SessionDateFormat properties [if set to 1 - Yes] in place of the BeginDate, EndDate, and DateFormat properties [if set to 0 - No]

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes for this control.

Note: Default value varies by control type.

Back to top