Reference

OpcTextPropertyNode Members

Type

OpcTextPropertyNode

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Inherits members from OpcPropertyNode, OpcVariableNode, OpcInstanceNode, OpcNode.

Constructors

OpcTextPropertyNode

10 overloads

Overload	Description
OpcTextPropertyNode(OpcName)	Initializes a new instance of the OpcTextPropertyNode class accessible by the name specified.
OpcTextPropertyNode(OpcName, OpcText)	Initializes a new instance of the OpcTextPropertyNode class accessible by the name specified with the initial value given by value.
OpcTextPropertyNode(OpcName, OpcNodeId)	Initializes a new instance of the OpcTextPropertyNode class accessible by the name and id specified.
OpcTextPropertyNode(OpcName, OpcNodeId, OpcText)	Initializes a new instance of the OpcTextPropertyNode class accessible by the name and id specified with the initial value given by value.
OpcTextPropertyNode(IOpcNode, OpcName)	Initializes a new instance of the OpcTextPropertyNode class accessible by the name specified as a child node of the parent node given.
OpcTextPropertyNode(IOpcNode, OpcName, OpcText)	Initializes a new instance of the OpcTextPropertyNode class accessible by the name specified with the initial value defined by value as a child node of the parent node given.
OpcTextPropertyNode(IOpcNode, OpcName, OpcNodeId)	Initializes a new instance of the OpcTextPropertyNode class accessible by the name and id specified as a child node of the parent node given.
OpcTextPropertyNode(IOpcNode, OpcName, OpcNodeId, OpcText)	Initializes a new instance of the OpcTextPropertyNode class accessible by the name and id specified with the initial value defined by value as a child node of the parent node given.
OpcTextPropertyNode(PropertyState<LocalizedText>)protected · since v2.50	Initializes a new instance of the OpcTextPropertyNode class using the content as the instance to wrap.
OpcTextPropertyNode(PropertyState<LocalizedText>, OpcNodeModel)protected · since v2.50	Initializes a new instance of the OpcTextPropertyNode class using the content as the instance to wrap.

OpcTextPropertyNode(OpcName)

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

public OpcTextPropertyNode(OpcName name)

Public Sub New(name As OpcName)

Parameters

Name	Type	Description
name	OpcName	The OpcName through that the new text property node can be accessed.

OpcTextPropertyNode(OpcName, OpcText)

Initializes a new instance of the OpcTextPropertyNode class accessible by the name specified with the initial value given by value.

public OpcTextPropertyNode(OpcName name, OpcText value)

Public Sub New(name As OpcName, value As OpcText)

Parameters

Name	Type	Description
name	OpcName	The OpcName through that the new text property node can be accessed.
value	OpcText	The initial value of the new text property node.

OpcTextPropertyNode(OpcName, OpcNodeId)

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

public OpcTextPropertyNode(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 text property node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new text property node can be identified and accessed.

OpcTextPropertyNode(OpcName, OpcNodeId, OpcText)

Initializes a new instance of the OpcTextPropertyNode class accessible by the name and id specified with the initial value given by value.

public OpcTextPropertyNode(OpcName name, OpcNodeId id, OpcText value)

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

Parameters

Name	Type	Description
name	OpcName	The OpcName through that the new text property node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new text property node can be identified and accessed.
value	OpcText	The initial value of the new text property node.

OpcTextPropertyNode(IOpcNode, OpcName)

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

public OpcTextPropertyNode(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 text property node can be accessed.

OpcTextPropertyNode(IOpcNode, OpcName, OpcText)

Initializes a new instance of the OpcTextPropertyNode class accessible by the name specified with the initial value defined by value as a child node of the parent node given.

public OpcTextPropertyNode(IOpcNode parent, OpcName name, OpcText value)

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

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 text property node can be accessed.
value	OpcText	The initial value of the new text property node.

OpcTextPropertyNode(IOpcNode, OpcName, OpcNodeId)

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

public OpcTextPropertyNode(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 text property node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new text property node can be identified and accessed.

OpcTextPropertyNode(IOpcNode, OpcName, OpcNodeId, OpcText)

Initializes a new instance of the OpcTextPropertyNode class accessible by the name and id specified with the initial value defined by value as a child node of the parent node given.

public OpcTextPropertyNode(
    IOpcNode parent,
    OpcName name,
    OpcNodeId id,
    OpcText value)

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

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 text property node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new text property node can be identified and accessed.
value	OpcText	The initial value of the new text property node.

OpcTextPropertyNode(PropertyState<LocalizedText>)

protected · since v2.50

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

protected OpcTextPropertyNode(PropertyState<LocalizedText> content)

Protected Sub New(content As PropertyState(Of LocalizedText))

Parameters

Name	Type	Description
content	PropertyState<LocalizedText>	The PropertyState<T> to wrap.

Exceptions

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

OpcTextPropertyNode(PropertyState<LocalizedText>, OpcNodeModel)

protected · since v2.50

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

protected OpcTextPropertyNode(
    PropertyState<LocalizedText> content,
    OpcNodeModel model)

Protected Sub New(
    content As PropertyState(Of LocalizedText),
    model As OpcNodeModel)

Parameters

Name	Type	Description
content	PropertyState<LocalizedText>	The PropertyState<T> 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

ReadTextPropertyValueCallback

Gets or sets a callback used to read the text property value.

public OpcReadTextPropertyValueCallback ReadTextPropertyValueCallback { get; set; }

Public Property ReadTextPropertyValueCallback As OpcReadTextPropertyValueCallback

Property value

OpcReadTextPropertyValueCallback

A OpcReadTextPropertyValueCallback used to read the text property value as the type OpcText. The value can also be a null reference (Nothing in Visual Basic).

Remarks

This callback is used in call chain with the ReadPropertyValueCallback and will be called with the outcome of that callback routine (in case there is one defined).

Value

Gets or sets the value of the property node.

public OpcText Value { get; set; }

Public Property Value As OpcText

Property value

OpcText

A OpcText representing the value of the property node. This can be also a null reference (Nothing in Visual Basic).

WriteTextPropertyValueCallback

Gets or sets a callback used to write the text property value.

public OpcWriteTextPropertyValueCallback WriteTextPropertyValueCallback { get; set; }

Public Property WriteTextPropertyValueCallback As OpcWriteTextPropertyValueCallback

Property value

OpcWriteTextPropertyValueCallback

A OpcWriteTextPropertyValueCallback used to write the text property value as the type OpcText. The value can also be a null reference (Nothing in Visual Basic).

Remarks

This callback is used in call chain with the WritePropertyValueCallback and will be called with the outcome of that callback routine (in case there is one defined).

Methods

ReadPropertyValueCore

protected · override

Reads the value of the property node using the context and value information specified.

protected override sealed OpcPropertyValue<object> ReadPropertyValueCore(
    OpcReadPropertyValueContext context,
    OpcPropertyValue<object> value)

Protected NotOverridable Overrides Function ReadPropertyValueCore(
    context As OpcReadPropertyValueContext,
    value As OpcPropertyValue(Of Object)) As OpcPropertyValue(Of Object)

Parameters

Name	Type	Description
context	OpcReadPropertyValueContext	The OpcReadPropertyValueContext to use to read the property node value.
value	OpcPropertyValue<Object>	The OpcPropertyValue<T> containing the currently used value constructed by the value information contained in the property node cache.

Returns

OpcPropertyValue<Object>

The OpcPropertyValue<T> read using the ReadPropertyValueCallback or the value if there is no custom callback routine defined.

Overrides

ReadPropertyValueCore

ReadTextPropertyValueCore

protected · virtual

Reads the text value of the property node using the context and value information specified.

protected virtual OpcPropertyValue<OpcText> ReadTextPropertyValueCore(
    OpcReadPropertyValueContext<OpcTextPropertyNode> context,
    OpcPropertyValue<OpcText> value)

Protected Overridable Function ReadTextPropertyValueCore(
    context As OpcReadPropertyValueContext(Of OpcTextPropertyNode),
    value As OpcPropertyValue(Of OpcText)) As OpcPropertyValue(Of OpcText)

Parameters

Name	Type	Description
context	OpcReadPropertyValueContext<OpcTextPropertyNode>	The OpcReadPropertyValueContext<T> to use to read the property node value.
value	OpcPropertyValue<OpcText>	The OpcPropertyValue<T> containing the currently used value constructed by the value information contained in the property node cache.

Returns

OpcPropertyValue<OpcText>

The OpcPropertyValue<T> read using the ReadTextPropertyValueCallback or the value if there is no custom callback routine defined.

ReadTextValue

Reads the text value of the property node.

public OpcText ReadTextValue(OpcReadVariableValueContext context)

Public Function ReadTextValue(context As OpcReadVariableValueContext) As OpcText

Parameters

Name	Type	Description
context	OpcReadVariableValueContext	The OpcReadVariableValueContext to use when reading the value.

Returns

OpcText

The OpcText value of the text property node read.

Exceptions

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

WritePropertyValueCore

protected · override

Writes the value of the property node using the context and value information specified.

protected override sealed OpcPropertyValue<object> WritePropertyValueCore(
    OpcWritePropertyValueContext context,
    OpcPropertyValue<object> value)

Protected NotOverridable Overrides Function WritePropertyValueCore(
    context As OpcWritePropertyValueContext,
    value As OpcPropertyValue(Of Object)) As OpcPropertyValue(Of Object)

Parameters

Name	Type	Description
context	OpcWritePropertyValueContext	The OpcWritePropertyValueContext to use to write the property node value.
value	OpcPropertyValue<Object>	The OpcPropertyValue<T> containing the currently used value constructed by the value information contained in the property node cache.

Returns

OpcPropertyValue<Object>

The OpcPropertyValue<T> written using the WritePropertyValueCallback or the value if there is no custom callback routine defined.

Overrides

WritePropertyValueCore

WriteTextPropertyValueCore

protected · virtual

Writes the text value of the property node using the context and value information specified.

protected virtual OpcPropertyValue<OpcText> WriteTextPropertyValueCore(
    OpcWritePropertyValueContext<OpcTextPropertyNode> context,
    OpcPropertyValue<OpcText> value)

Protected Overridable Function WriteTextPropertyValueCore(
    context As OpcWritePropertyValueContext(Of OpcTextPropertyNode),
    value As OpcPropertyValue(Of OpcText)) As OpcPropertyValue(Of OpcText)

Parameters

Name	Type	Description
context	OpcWritePropertyValueContext<OpcTextPropertyNode>	The OpcWritePropertyValueContext<T> to use to write the property node value.
value	OpcPropertyValue<OpcText>	The OpcPropertyValue<T> containing the currently used value constructed by the value information contained in the property node cache.

Returns

OpcPropertyValue<OpcText>

The OpcPropertyValue<T> written using the WriteTextPropertyValueCallback or the value if there is no custom callback routine defined.

WriteTextValue

Writes the value of the property node specified by value.

public void WriteTextValue(OpcWriteVariableValueContext context, OpcText value)

Public Sub WriteTextValue(
    context As OpcWriteVariableValueContext,
    value As OpcText)

Parameters

Name	Type	Description
context	OpcWriteVariableValueContext	The OpcWriteVariableValueContext to use when writing the value.
value	OpcText	The OpcText value of the text property node to write.

Exceptions

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