ANSI C UA Server SDK
1.5.3.333
|
Reference | NodeClass | BrowseName | DataType | ValueRank | TypeDefinition | ModellingRule |
---|---|---|---|---|---|---|
HasSupertype | ObjectType | ConditionType | ||||
HasProperty | Variable | CancelResponse | Int32 | Scalar | PropertyType | Mandatory |
HasProperty | Variable | DefaultResponse | Int32 | Scalar | PropertyType | Mandatory |
HasComponent | Variable | DialogState | LocalizedText | Scalar | TwoStateVariableType | Mandatory |
HasComponent | Variable | EnabledState | LocalizedText | Scalar | TwoStateVariableType | Mandatory |
HasProperty | Variable | LastResponse | Int32 | Scalar | PropertyType | Mandatory |
HasProperty | Variable | OkResponse | Int32 | Scalar | PropertyType | Mandatory |
HasProperty | Variable | Prompt | LocalizedText | Scalar | PropertyType | Mandatory |
HasComponent | Method | Respond | Mandatory | |||
HasProperty | Variable | ResponseOptionSet | LocalizedText | OneDimension | PropertyType | Mandatory |
Used to represent Conditions as dialogs.
The DialogConditionType inherits all Properties of the ConditionType.
Prompt is a dialog prompt to be shown to the user.
DialogState when set to TRUE indicates that the Dialog is active and waiting for a response. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Inactive | Active |
de | Inaktiv | Aktiv |
fr | Inactive | Active |
Specifies the desired set of responses as array of LocalizedText.
The index in this array is used for the corresponding fields like DefaultResponse, LastResponse and SelectedOption in the Respond method. The recommended Dialog response option names in different locales are listed in the following table.
Locale “en” | Locale “de” |
---|---|
Ok | OK |
Cancel | Abbrechen |
Yes | Ja |
No | Nein |
Abort | Abbrechen |
Retry | Wiederholen |
Ignore | Ignorieren |
Next | Nächster |
Previous | Vorheriger |
Typical combinations of response options are
Identifies the response option that should be shown as default to the user.
It is the index in the ResponseOptionSet array. If no response option is the default, the value of the Property is -1.
Provides the index of the OK option in the ResponseOptionSet array.
This choice is the response that will allow the system to proceed with the operation described by the prompt. This allows a Client to identify the OK option if a special handling for this option is available. If no OK option is available the value of this Property is -1.
Provides the index of the response in the ResponseOptionSet array that will cause the Dialog to go into the inactive state without proceeding with the operation described by the prompt.
This allows a Client to identify the Cancel option if a special handling for this option is available. If no Cancel option is available the value of this Property is -1.
Contains the last response provided by a Client in the Respond method.
If no previous response exists then the value of the Property is -1.
Respond is used to pass the selected response option and end the dialog.
DialogState will return to FALSE.
Method Result Codes
ResultCode | Description |
---|---|
Bad_DialogNotActive | The DialogConditionType instance is not in Active state. |
Bad_DialogResponseInvalid | The selected option is not a valid index in the ResponseOptionSet array. |
Input Arguments
Argument | DataType | ValueRank | Description |
---|---|---|---|
SelectedResponse | Int32 | Scalar | Selected index of the ResponseOptionSet array. |