CxFmsReportCtrl Properties
The CxFmsReportCtrl object contains the following properties.
General Properties
| 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 data to display in the FMS Report 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 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 6 - Node_Category1_Any. |
|
|
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 |
Note: This property is only used if the UseSessionOptions property is set to 0 - No. Returns/sets the ending date of the selected FMS Report This string can be in one of the following forms.
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. |
|
|
StdFont |
No |
Returns/sets the font used by the FMS Report control Click … to access the Font dialog box to make font selections. Default value is MS Shell Dlg. |
|
|
String |
No |
If Use Session Node is not selected, is set to 0 - No, returns/sets the Node name against which to run the report |
|
|
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 Report 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 |
Returns/sets the XML specifying the user-configured report definition |
|
|
String |
No |
Returns/sets the report currently selected in the Node chooser’s Type combo box |
|
|
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. |
|
|
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 Reports 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. |
|
|
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. |
|
|
String |
No |
Returns/sets the unit set used to determine the units in which to display data in the selected report Another way to configure this property is to use the control’s property page or to set the Unit set parameter value in the control. Default value is the <Default> unit set See Configuring Unit Set Definitions for more information about viewing unit set definitions in your system. |
|
|
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 0 - No for this control. Note: Default value varies by control type. |
|
|
Boolean |
No |
Returns/sets whether to use the SessionBeginDate and SessionEndDate properties [if set to 1 - Yes] in place of the BeginDate and EndDate properties [if set to 0 - No] Possible values for this property are as follows.
Default value is 0 - No for this control. Note: Default value varies by control type. |


