|
<< Click to Display Table of Contents >>
xfCommandUnit |
Specifies a command action inside an xfCommand-type object.
Properties of the xfCommandUnit object
Property |
Data Type |
Description |
|---|---|---|
CheckInterlock |
Boolean |
Requests or not an update on the Interlocked property |
DirectBit |
Number |
Number of the bit to operate in the UseDirectBitWrite property |
Exec |
Boolean |
Executes or not a Command |
HasConfirmation |
Boolean |
Indicates whether a confirmation window must be opened or not in the application |
HasESign |
Boolean |
Indicates whether the operation Screen or window must use electronic signature |
Interlocked |
Boolean |
Indicates the interlock situation based on the interlock status of child objects |
InterlockMode |
Enumeration |
Used by the Screen object to perform or inform the execution of a Command. Possible values for this property are 0: cimDoNothing, 1: cimWarning ou 2: cimBlockCommand (default) |
InterlockModeStatus |
Enumeration |
Result of checking the interlock. Possible values for this property are 0: cimDoNothing, 1: cimWarning ou 2: cimBlockCommand (default) |
LastCommandResult |
Number |
Situation of the last Command. Possible values for this property are 0: OK (default), 1: Failure, 2: Command not authorized, or 3: Interlocked |
Order |
Number |
Default sorting order that can be used on Screens |
UseDirectBitWrite |
Boolean |
Indicates whether a writing is performed or not in the bit indicated by the DirectBit property |
UserComment |
Text |
User-typed comment on the Electronic Signature window |
WriteTag |
Link |
Link to an IOTag-type object for writing |
WriteValue |
Variant |
Value to write to the Link indicated in the WriteTag property |
If the UseDirectBitWrite property is equal to True, then the value of the WriteValue property is sent to the bit informed in the DirectBit property of the Tag indicated in the WriteTag property. If two actions are needed in the same bit or in other bits, such as turning on and off, users must create an xfCommandUnit object for each action. Otherwise, the value of the WriteValue property is directly set to the Tag indicated in the WriteTag property.