CxFmsClosePeriodCtrl Properties

The CxFmsClosePeriodCtrl object contains the following properties.

General Properties

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.

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.

ChooserAllowMultiSelect

Boolean

No

Returns/sets whether or not the user can select multiple Nodes in the Node chooser

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes.

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_Category4_Device
  • 2 – Node_Category4_Group
  • 3 – Node_Category4_Station
  • 8 – Node_Category4_Gas_Device
  • 9 – Node_Category4_Liquid_Device

Default value is 2 - Node_Category4_Group.

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.

Font

StdFont

No

Returns/sets the font used by the FMS Close Period 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 Close Period 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.

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.

UsePIT

Boolean

No

Returns/sets whether or not to use the PITDateTime property [if set to 1 - Yes]

Possible values for this property are as follows.

  • 0 – No
  • 1 – Yes

Default value is 0 - No.

See Using the Home Menu for more information about PIT mode.

Back to top