Scripting > CxHmiFms > CxFmsNodeChooserCtrl Object > CxFmsNodeChooserCtrl Properties

CxFmsNodeChooserCtrl Properties

The CxFmsNodeChooserCtrl object contains the following properties.

General Properties

Property SubType Read Only Description

AllowMultiSelect

Boolean

No

Returns/sets whether or not the user can select multiple Nodes.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

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

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

ButtonText

String

No

Returns/sets the text that accompanies the action button at the bottom of the FMS Node Chooser.  The button’s function can be configured by implementing the Updated event.

Allowable characters (maximum of 20) are A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing.

Default value is Set as Session Node

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.

FilterString

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)

FilterType

Integer

No

Returns/sets the Node property that will be filtered by the string specified in the FilterString property.

Possible values for this property are as follows.

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

Default value is 0 - Name

Font

StdFont

No

Returns/sets the font used by the FMS Node Chooser control. Click to access the Font dialog box to make font selections.

Default value is MS Shell Dlg.

GroupSelection

String

No

Returns/sets the group currently selected in the Group combo box.

NodeCategorySelection

Integer

No

Returns/sets the Node category currently selected in Node category combo box.

Possible values for this property are as follows.

  • 6 – <Any> Node_Category_Any
  • 2 – Group Node_Category_Group
  • 1 – Device Node_Category_Device
  • 8 - Gas device Node_Category_Gas_Device
  • 9 - Liquid device Node_Category_Liquid_Device
  • 13 – Accessory Node_Category_Accessory
  • 3 – Station Node_Category_Station

Default value is 6 - <Any>

NodeCategoryVisible

Boolean

No

Returns/sets whether or not the Node category combo box is visible.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

PITDateTime

String

No

Returns/sets the Point in Time date and time of the FMS Node Chooser control. 

This string can be in one of the following forms.

  • Absolute Date/Time (for example, 1/31/2019 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.

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

PrimarySortColumn

Integer

No

Returns/sets the primary sort column of the 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

SiteServiceSelection

String

No

Returns/sets the Site.Service currently selected in the FMS Service combo box.

SiteServiceVisible

Boolean

No

Returns/sets whether or not the FMS service combo box is visible.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

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

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.