Reference

OpcDialogConditionNode Members

Type

OpcDialogConditionNode

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Inherits members from OpcConditionNode, OpcEventNode, OpcObjectNode, OpcInstanceNode, OpcNode.

Constructors

OpcDialogConditionNode

6 overloads

Overload	Description
OpcDialogConditionNode(OpcName)	Initializes a new instance of the OpcDialogConditionNode class accessible by the name specified.
OpcDialogConditionNode(OpcName, OpcNodeId)	Initializes a new instance of the OpcDialogConditionNode class accessible by the name and id specified.
OpcDialogConditionNode(IOpcNode, OpcName)	Initializes a new instance of the OpcDialogConditionNode class accessible by the name specified as a child node of the parent node given.
OpcDialogConditionNode(IOpcNode, OpcName, OpcNodeId)	Initializes a new instance of the OpcDialogConditionNode class accessible by the name and id specified as a child node of the parent node given.
OpcDialogConditionNode(DialogConditionState)protected · since v2.50	Initializes a new instance of the OpcDialogConditionNode class using the content as the instance to wrap.
OpcDialogConditionNode(DialogConditionState, OpcNodeModel)protected · since v2.50	Initializes a new instance of the OpcDialogConditionNode class using the content as the instance to wrap.

OpcDialogConditionNode(OpcName)

Initializes a new instance of the OpcDialogConditionNode class accessible by the name specified.

public OpcDialogConditionNode(OpcName name)

Public Sub New(name As OpcName)

Parameters

Name	Type	Description
name	OpcName	The OpcName through that the new dialog condition node can be accessed.

OpcDialogConditionNode(OpcName, OpcNodeId)

Initializes a new instance of the OpcDialogConditionNode class accessible by the name and id specified.

public OpcDialogConditionNode(OpcName name, OpcNodeId id)

Public Sub New(name As OpcName, id As OpcNodeId)

Parameters

Name	Type	Description
name	OpcName	The OpcName through that the new dialog condition node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new dialog condition node can be identified and accessed.

OpcDialogConditionNode(IOpcNode, OpcName)

Initializes a new instance of the OpcDialogConditionNode class accessible by the name specified as a child node of the parent node given.

public OpcDialogConditionNode(IOpcNode parent, OpcName name)

Public Sub New(parent As IOpcNode, name As OpcName)

Parameters

Name	Type	Description
parent	IOpcNode	The IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
name	OpcName	The OpcName through that the new dialog condition node can be accessed.

OpcDialogConditionNode(IOpcNode, OpcName, OpcNodeId)

Initializes a new instance of the OpcDialogConditionNode class accessible by the name and id specified as a child node of the parent node given.

public OpcDialogConditionNode(IOpcNode parent, OpcName name, OpcNodeId id)

Public Sub New(parent As IOpcNode, name As OpcName, id As OpcNodeId)

Parameters

Name	Type	Description
parent	IOpcNode	The IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
name	OpcName	The OpcName through that the new dialog condition node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new dialog condition node can be identified and accessed.

OpcDialogConditionNode(DialogConditionState)

protected · since v2.50

Initializes a new instance of the OpcDialogConditionNode class using the content as the instance to wrap.

protected OpcDialogConditionNode(DialogConditionState content)

Protected Sub New(content As DialogConditionState)

Parameters

Name	Type	Description
content	DialogConditionState	The DialogConditionState to wrap.

Exceptions

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

OpcDialogConditionNode(DialogConditionState, OpcNodeModel)

protected · since v2.50

Initializes a new instance of the OpcDialogConditionNode class using the content as the instance to wrap.

protected OpcDialogConditionNode(
    DialogConditionState content,
    OpcNodeModel model)

Protected Sub New(content As DialogConditionState, model As OpcNodeModel)

Parameters

Name	Type	Description
content	DialogConditionState	The DialogConditionState to wrap.
model	OpcNodeModel	The OpcNodeModel which defines the modelling directives for the new node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the node.

Exceptions

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

Properties

CancelResponse

Gets or sets 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; set; }

Public 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.

CancelResponseNode

Gets the OpcPropertyNode<T> of the CancelResponse property.

public OpcPropertyNode<int> CancelResponseNode { get; }

Public ReadOnly Property CancelResponseNode As OpcPropertyNode(Of Integer)

Property value

OpcPropertyNode<Int32>

An instance of the OpcPropertyNode<T> class.

DefaultResponse

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

public int DefaultResponse { get; set; }

Public 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.

DefaultResponseNode

Gets the OpcPropertyNode<T> of the DefaultResponse property.

public OpcPropertyNode<int> DefaultResponseNode { get; }

Public ReadOnly Property DefaultResponseNode As OpcPropertyNode(Of Integer)

Property value

OpcPropertyNode<Int32>

An instance of the OpcPropertyNode<T> class.

DefaultTypeDefinitionId

protected · override

Gets the default identifier which identifies the node that defines the underlying node type from that this OpcInstanceNode has been created.

protected override OpcNodeId DefaultTypeDefinitionId { get; }

Protected Overrides ReadOnly Property DefaultTypeDefinitionId As OpcNodeId

Property value

OpcNodeId

The OpcNodeId of the type node from that this OpcInstanceNode has been created from. These type node defines the typical structure of an instance node of its type definition. If there exists no specific type definition node a null reference (Nothing in Visual Basic).

Overrides

DefaultTypeDefinitionId

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.

Remarks

The value is false after the node has been created: the DialogState starts inactive, so a new dialog condition is not waiting for a response yet. ActivateDialog makes it active. RespondDialog and Respond make it inactive again.

IsActiveNode

Gets the OpcTwoStateVariableNode of the IsActive property.

public OpcTwoStateVariableNode IsActiveNode { get; }

Public ReadOnly Property IsActiveNode As OpcTwoStateVariableNode

Property value

OpcTwoStateVariableNode

An instance of the OpcTwoStateVariableNode class.

LastResponse

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

public int LastResponse { get; set; }

Public 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.

LastResponseNode

Gets the OpcPropertyNode<T> of the LastResponse property.

public OpcPropertyNode<int> LastResponseNode { get; }

Public ReadOnly Property LastResponseNode As OpcPropertyNode(Of Integer)

Property value

OpcPropertyNode<Int32>

An instance of the OpcPropertyNode<T> class.

OkResponse

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

public int OkResponse { get; set; }

Public 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. 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 is -1.

OkResponseNode

Gets the OpcPropertyNode<T> of the OkResponse property.

public OpcPropertyNode<int> OkResponseNode { get; }

Public ReadOnly Property OkResponseNode As OpcPropertyNode(Of Integer)

Property value

OpcPropertyNode<Int32>

An instance of the OpcPropertyNode<T> class.

Prompt

Gets or sets the dialog prompt to be shown to the user.

public OpcText Prompt { get; set; }

Public Property Prompt As OpcText

Property value

OpcText

The message to be shown to the user.

PromptNode

Gets the OpcTextPropertyNode of the Prompt property.

public OpcTextPropertyNode PromptNode { get; }

Public ReadOnly Property PromptNode As OpcTextPropertyNode

Property value

OpcTextPropertyNode

An instance of the OpcTextPropertyNode class.

RespondCallback

Gets or sets a callback used to respond on a dialog of the OpcDialogConditionNode.

public OpcDialogRespondCallback RespondCallback { get; set; }

Public Property RespondCallback As OpcDialogRespondCallback

Property value

OpcDialogRespondCallback

A OpcDialogRespondCallback used to respond on a dialog of the dialog condition node. The value can also be a null reference (Nothing in Visual Basic).

RespondNode

Gets the OpcDialogResponseMethodNode used to handle 'Respond' method calls to respond on a dialog of the condition node.

public OpcDialogResponseMethodNode RespondNode { get; }

Public ReadOnly Property RespondNode As OpcDialogResponseMethodNode

Property value

OpcDialogResponseMethodNode

An instance of the OpcDialogResponseMethodNode class. Which uses an OpcDialogConditionNode defined callback to respond on a dialog of the condition node.

ResponseOptions

Gets or sets an array of supported response options.

public OpcText[] ResponseOptions { get; set; }

Public 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.

ResponseOptionsNode

Gets the OpcTextArrayPropertyNode of the ResponseOptions property.

public OpcTextArrayPropertyNode ResponseOptionsNode { get; }

Public ReadOnly Property ResponseOptionsNode As OpcTextArrayPropertyNode

Property value

OpcTextArrayPropertyNode

An instance of the OpcTextArrayPropertyNode class.

Methods

CreateBranchCore

protected · override

Creates a new instance of the OpcDialogConditionNode using the same Id and Name as this node.

protected override OpcConditionNode CreateBranchCore()

Protected Overrides Function CreateBranchCore() As OpcConditionNode

Returns

OpcConditionNode

A new instance of the OpcDialogConditionNode identifiable and accessible througth the same Id and Name as this node.

Overrides

CreateBranchCore

Respond

Responses on the dialog of the dialog condition node and changes the IsActive to its FalseState using the specified context.

public void Respond(OpcContext context, int selectedResponse)

Public Sub Respond(context As OpcContext, selectedResponse As Integer)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use.
selectedResponse	Int32	The selected index of the item in the ResponseOptions.

Exceptions

Exception	Condition
ArgumentNullException	The context is a null reference (Nothing in Visual Basic).
OpcException	The call failed (see exception details for more information).

RespondCore

protected · virtual

Responds on the dialog of the dialog condition node using the context and selectedResponse information specified.

protected virtual OpcStatusCode RespondCore(
    OpcNodeContext<OpcDialogConditionNode> context,
    int selectedResponse)

Protected Overridable Function RespondCore(
    context As OpcNodeContext(Of OpcDialogConditionNode),
    selectedResponse As Integer) As OpcStatusCode

Parameters

Name	Type	Description
context	OpcNodeContext<OpcDialogConditionNode>	The OpcNodeContext<T> to use to respond on the dialog of the dialog condition node.
selectedResponse	Int32	The selected index of the item in the ResponseOptions.

Returns

OpcStatusCode

The OpcStatusCode specifying the outcome of the respond using the RespondCallback or BadNotSupported if there is no custom callback routine defined.