This class is designed for command keywords that have Boolean values.
Constructor.
Argument | Type | Default | Description |
command | AFXCommand | Host command. | |
name | String | Keyword name. | |
booleanType | Type | ON_OFF | Type of boolean used in the command. |
isRequired | Int | FALSE | TRUE if the keyword is a required argument of the command. |
defaultValue | Int | FALSE | Default value. |
Returns the text string that represents the keyword's current value.
Implements AFXKeyword.
Returns TRUE if the keyword value differs from its previous value.
Implements AFXKeyword.
Sets the keyword's default value.
Argument | Type | Default | Description |
defaultValue | Int | Default value. |
Sets the keyword's default value (returns TRUE if the given text string is valid).
Argument | Type | Default | Description |
defaultValueString | String | Default value in text string form. |
Sets the keyword's default value (returns TRUE if the given text string is valid).
Argument | Type | Default | Description |
defaultValueString | String | Default value in text string form. |
Sets the keyword's current value.
Argument | Type | Default | Description |
newValue | Int | New value. |
Sets the keyword's current value (returns TRUE if the given text string is valid).
Argument | Type | Default | Description |
newValueString | String | New value in text string form. |
Sets the keyword's current value (returns TRUE if the given text string is valid).
Argument | Type | Default | Description |
newValueString | String | New value in text string form. |
Sets the keyword value to its default.
Argument | Type | Default | Description |
ignoreUnspecified | Int | FALSE | Not used. |
Sets the keyword value to its previous value.
Implements AFXKeyword.