Reference

OpcDialogCondition Members

Type

OpcDialogCondition

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Inherits members from OpcCondition, OpcEvent.

Constructors

OpcDialogCondition

since v2.8

Initializes a new instance of the OpcDialogCondition class using the dataStore specified.

public OpcDialogCondition(IOpcReadOnlyNodeDataStore dataStore)

Public Sub New(dataStore As IOpcReadOnlyNodeDataStore)

Parameters

Name	Type	Description
dataStore	IOpcReadOnlyNodeDataStore	The IOpcReadOnlyNodeDataStore of the 'Opc.UaFx.OpcDialogConditionNode' to represent.

Exceptions

Exception	Condition
ArgumentNullException	The dataStore is a null reference (Nothing in Visual Basic).

Properties

CancelResponse

Gets a value which defines the index of the response in the ResponseOptions array that will cause the dialog to go into the inactive state without proceeding with the operation described by the prompt.

public int CancelResponse { get; }

Public ReadOnly Property CancelResponse As Integer

Property value

Int32

The value 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 is -1. For more information 'Opc.UaFx.OpcDialogConditionNode.CancelResponse'.

DefaultResponse

Gets a value which identifies the response option that should be shown as default to the user.

public int DefaultResponse { get; }

Public ReadOnly Property DefaultResponse As Integer

Property value

Int32

The index to an item in the ResponseOptions array. If no response option is the default, the value is -1. For more information see 'Opc.UaFx.OpcDialogConditionNode.DefaultResponse'.

IsActive

Gets a value indicating whether the dialog is active and is waiting for a response.

public bool IsActive { get; }

Public ReadOnly Property IsActive As Boolean

Property value

Boolean

A value indicating whether the dialog is active and is waiting for a response. For more information see 'Opc.UaFx.OpcDialogConditionNode.IsActive'.

LastResponse

Gets a value which defines the last response provided by a client in the respond method.

public int LastResponse { get; }

Public ReadOnly Property LastResponse As Integer

Property value

Int32

The index to an item in the ResponseOptions array. If no previous response exists then the value is -1. For more information see 'Opc.UaFx.OpcDialogConditionNode.LastResponse'.

OkResponse

Gets a value which defines the index of the OK option in the ResponseOptions array.

public int OkResponse { get; }

Public ReadOnly Property OkResponse As Integer

Property value

Int32

This choice is the response that will allow the system to proceed with the operation described by the prompt. If no OK option is available the value is -1. For more information see 'Opc.UaFx.OpcDialogConditionNode.OkResponse'.

Prompt

Gets the dialog prompt to be shown to the user.

public OpcText Prompt { get; }

Public ReadOnly Property Prompt As OpcText

Property value

OpcText

The message to be shown to the user. For more information see 'Opc.UaFx.OpcDialogConditionNode.Prompt'.

ResponseOptions

Gets an array of supported response options.

public OpcText[] ResponseOptions { get; }

Public ReadOnly Property ResponseOptions As OpcText()

Property value

OpcText[]

An array of supported response options. The index in this array is used for the corresponding properties like DefaultResponse, LastResponse and the selected response in the respond method. For more information see 'Opc.UaFx.OpcDialogConditionNode.ResponseOptions'.