CxFmsConfigCtrl Properties
The CxFmsConfigCtrl object contains the following properties.
General Properties
Browse by letter: [A] [B] [C] [D] [E] [F] [I] [P] [S] [U]
| Property | SubType | Read Only | Description |
|---|---|---|---|
|
Integer |
No |
Returns/sets the appearance of the object boundary. Possible values for this property are as follows.
Default value is 0 - Flat. |
|
|
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 Configuration control. This string can be in one of the following forms.
Default value is T-7. See Selecting Date and Time for more information. |
|
|
Integer |
No |
Returns/sets the border style. Possible values for this property are as follows.
Default value is 0 - None. |
|
|
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. ExampleA 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). |
|
|
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.
Default value is 0 - Name. |
|
|
String |
No |
Returns/sets the group currently selected in the Node chooser’s Group combo box |
|
|
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.
Default value is 1 - Node_Category5_Device. |
|
|
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.
Default value is 1 - Yes. |
|
|
Integer |
No |
Returns/sets the primary sort column of the Node chooser’s Node list. Possible values for this property are as follows.
Default value is 2 - Name ascending. |
|
|
String |
No |
Returns/sets the Site.Service currently selected in the Node chooser’s FMS combo box. |
|
|
Boolean |
No |
Returns/sets whether or not the Node chooser’s FMS combo box is visible. Possible values for this property are as follows.
Default value is 1 - Yes. |
|
|
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. |
|
|
String |
No |
Returns/sets the XML specifying the columns that will be displayed in the FMS Configuration control, for either data view. 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 Configuration Control for more information. |
|
| DataView | Integer | No |
Returns/sets the type of data view shown in the FMS Configuration control. Possible values for this property are as follows.
Default value is 0 - Configuration. |
|
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 Configuration control. Possible values for this property are as follows.
Default value is 0 - Device time . |
|
|
Integer |
No |
Returns/sets the number of decimal places that will be shown in the values displayed by the FMS Configuration control. Acceptable values include 0 -10 decimal places. Default value is 7. |
|
|
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 Configuration control. This string can be in one of the following forms.
Default value is T. See Selecting Date and Time for more information. |
|
|
String |
No |
Returns/sets the XML string specifying the filter settings to use for data display in the FMS Configuration control. Filter property options correspond to data view selection. See Configure Filter in the Using the Configuration Control topic for more information about available filter settings corresponding to each data view. In Configuration data view, when DataView = 0 - Data_View_Config, possible values are as follows. Data sources to show:
Default value is 255 - Any. In Gas analysis data view, when DataView = 1 - Data_View_Gas_Analysis possible values are as follows. Data sources to show:
Default value is 255 - Any. Status to show:
Default is all source/status values selected. Another way to configure this property is to use the OCX Properties dialog box (Configuration page). |
|
|
StdFont |
No |
Returns/sets the font used by the FMS Configuration control. Click … to access the Font dialog box to make font selections. Default value is MS Shell Dlg. |
|
|
Boolean |
Yes |
Returns whether or not the user is currently editing data in the FMS Configuration control. |
|
|
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 Configuration control. This string can be in one of the following forms.
Default value is T, date and time today. See Using the Home Menu for more information about PIT mode. |
|
|
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.
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. |
|
|
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.
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. |
|
|
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.
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. |
|
|
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 Configuration 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. |
|
|
OLE_COLOR |
No |
Returns/sets the color of the cells in the control. Click to access or change color configuration. See Context Menu for the selected data view for more information about this property. Default value is 255.250.205 (pale yellow) |
|
|
OLE_COLOR |
No |
Returns/sets the color of the text in the control. Click to access or change color configuration. See Context Menu for the selected data view for more information about this property. Default value is 0.0.0 (black). |
|
|
Boolean |
No |
Returns/sets whether or not the Chooser pane will be displayed in the control. Possible values for this property are as follows.
Default value is 1 - Yes. |
|
|
Boolean |
No |
Returns/sets whether or not the Options pane will be displayed in the control. Possible values for this property are as follows.
Default value is 1 - Yes. |
|
| ShowShading | Integer | No |
Returns/sets which parts of the cells will be shaded with color as defined by ShadingBackColor and ShadingForeColor. Possible values for this property are as follows.
Default value is 3 - Both, shade both text and cell. See Context Menu for the selected data view for more information about this property. |
|
String |
No |
Returns/sets the unit set used to determine the units of each FMS data item in the FMS Configuration control. Another way to configure this property is to use either the control’s property page or to use the Options pane. Default value is the <Default> unit set, or as configured |
|
| UseFilterConfig | Boolean | No |
Returns/sets whether or not to use the configured filter values (FilterConfigXml) to determine what data to display in the control. Possible values for this property are as follows.
Default value is 0 - No. |
|
Boolean |
No |
Returns/sets whether or not the PITDateTime property will be used. Possible values for this property are as follows.
Default value is 0 - No. |
|
|
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.
Default value is 1 - Yes for this control. Note: Default value varies by control type. |
|
|
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.
Default value is 1 - Yes for this control. Note: Default value varies by control type. |


