CxFmsJobsCtrl Properties
The CxFmsJobsCtrl 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 the FMS Jobs 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. |
|
|
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.
Default value is 1 - Yes. |
|
|
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. 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 8 - Node_Category1_Gas_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. |
|
|
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 Jobs control Possible values for this property are as follows.
Default value is 0 — Device time. |
|
|
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 Jobs control This string can be in one of the following forms.
Default value is T. See Selecting Date and Time for more information. |
|
|
StdFont |
No |
Returns/sets the font used by the FMS Jobs control Click … to access the Font dialog box to make font selections. Default value is MS Shell Dlg. |
|
|
String |
No |
Returns/sets the type of jobs to display in the FMS Jobs control Type the name of a job type into the text box to define the filter view desired. Options are as follows.
Default value is <Any> jobs. Note: Job types are configured in CygNet Dispatch or in FMS Explorer via the Extended Command Options on the Job Schedule Configuration page. |
|
|
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 Jobs 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 Jobs 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 jobs with a status of "Approved" 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 jobs with a status of "Blocked" 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 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 jobs with a status of "Completed" 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 jobs with a status of "Missing Data" 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 jobs with a status of "Open" 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. |
|
|
Boolean |
No |
Returns/sets whether or not jobs with a status of "Pending Approval" 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 jobs with a status of "Review" 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 jobs with a status of "Verified" 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 jobs with a status of "Waiting for Events" 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 of each FMS data item in the FMS Jobs 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 Jobs control. Default value is the <Default> unit set. |
|
|
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 or not the SessionNodeTag [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 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. |


