OPC Studio User's Guide and Reference
DefaultEncodingId Property (UAStructureDefinition)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.DataTypeSchema Namespace > UAStructureDefinition Class : DefaultEncodingId Property
The Node ID of the default data type encoding for the data type.
Syntax
'Declaration
 
Public Property DefaultEncodingId As UANodeId
'Usage
 
Dim instance As UAStructureDefinition
Dim value As UANodeId
 
instance.DefaultEncodingId = value
 
value = instance.DefaultEncodingId
public UANodeId DefaultEncodingId {get; set;}
public:
property UANodeId^ DefaultEncodingId {
   UANodeId^ get();
   void set (    UANodeId^ value);
}

Property Value

The value of this property cannot be null (Nothing in Visual Basic).

Because there is an implicit conversion from OpcLabs.EasyOpc.UA.AddressSpace.UANodeId to OpcLabs.EasyOpc.UA.UANodeDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned OpcLabs.EasyOpc.UA.AddressSpace.UANodeId in any place where the OpcLabs.EasyOpc.UA.UANodeDescriptor is expected as input, and the corresponding node descriptor will be constructed automatically.

Also, because the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId has an implicit conversion to System.String, and it converts to the expanded text of the node Id (ExpandedText), in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned OpcLabs.EasyOpc.UA.AddressSpace.UANodeId in any place where expanded text of a node Id (a string) is expected as input, and the corresponding expanded text will be taken automatically from the node Id.

Remarks

The default depends on the message encoding, Default Binary for UA Binary encoding, Default JSON for JSON encoding and Default XML for XML encoding. If the data type is only used inside nested structures and is not directly contained in an extension object, the encoding Node ID is null.

Because the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the expanded text of the nodeId) in place of OpcLabs.EasyOpc.UA.AddressSpace.UANodeId value when setting this property, and the corresponding OPC UA node Id will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UANodeId Constructor(String) constructor instead.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also