OPC Studio User's Guide and Reference
Format Method (_UANodeId)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.AddressSpace.ComTypes Namespace > _UANodeId Interface : Format Method
The default namespace URI string. When this parameter is not a null reference, the formatted string will not explicitly include the namespace specifier if the namespace is equal to the default namespace.

The value of this parameter can be null (Nothing in Visual Basic).

Determines whether node IDs that have a standard name will be formatted as the standard name only.

The value represents an OPC UA namespace URI string. Any string can be passed to this parameter (i.e. will not cause System.ArgumentException), but not all values make sense and will work when an operation using them is attempted.

Formats the node Id object into a string.
Syntax
'Declaration
 
<NotNullAttribute()>
Function Format( _
   ByVal defaultNamespaceUriString As String, _
   ByVal useStandardNames As Boolean _
) As String
'Usage
 
Dim instance As _UANodeId
Dim defaultNamespaceUriString As String
Dim useStandardNames As Boolean
Dim value As String
 
value = instance.Format(defaultNamespaceUriString, useStandardNames)

Parameters

defaultNamespaceUriString
The default namespace URI string. When this parameter is not a null reference, the formatted string will not explicitly include the namespace specifier if the namespace is equal to the default namespace.

The value of this parameter can be null (Nothing in Visual Basic).

useStandardNames
Determines whether node IDs that have a standard name will be formatted as the standard name only.

The value represents an OPC UA namespace URI string. Any string can be passed to this parameter (i.e. will not cause System.ArgumentException), but not all values make sense and will work when an operation using them is attempted.

Return Value

The formatted node Id string (expanded text).

This method never returns null (Nothing in Visual Basic).

Remarks

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

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