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



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Navigation.Extensions Namespace > UABrowsePathElementCollectionExtension Class : Format Method
The browse path element collection.

Because the OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElementCollection has an implicit conversion from OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedNameCollection, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedNameCollection (containing a sequence of qualified names, assumed to form a relative browse path using "any hierarchical" forward references) in place of this parameter, and the corresponding OPC UA browse path element collection will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromUAQualifiedNameCollection static method instead.

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

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

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

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.

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

Formats the browse path element collection (a relative path) into a string.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function Format( _
   ByVal browsePathElementCollection As UABrowsePathElementCollection, _
   ByVal defaultNamespaceUriString As String _
) As String
'Usage
 
Dim browsePathElementCollection As UABrowsePathElementCollection
Dim defaultNamespaceUriString As String
Dim value As String
 
value = UABrowsePathElementCollectionExtension.Format(browsePathElementCollection, defaultNamespaceUriString)

Parameters

browsePathElementCollection
The browse path element collection.

Because the OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElementCollection has an implicit conversion from OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedNameCollection, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedNameCollection (containing a sequence of qualified names, assumed to form a relative browse path using "any hierarchical" forward references) in place of this parameter, and the corresponding OPC UA browse path element collection will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromUAQualifiedNameCollection static method instead.

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

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

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

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.

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

Return Value

The formatted relative path string.

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

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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