BrowseName Property (UANodeElement)

Browse name of the node (this string is intended for programmatic use).

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Property BrowseName As UAQualifiedName

'Usage
 
Dim instance As UANodeElement
Dim value As UAQualifiedName
 
instance.BrowseName = value
 
value = instance.BrowseName

public UAQualifiedName BrowseName {get; set;}

public:
property UAQualifiedName^ BrowseName {
   UAQualifiedName^ get();
   void set (    UAQualifiedName^ value);
}

Property Value

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

The default value of this property is UAQualifiedName.Null.

Because the UAQualifiedName has an implicit conversion to System.String, and it converts to the expanded text of the qualified name (UAQualifiedName.ExpandedText), in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned UAQualifiedName in any place where expanded text of a qualified name (a string) is expected as input, and the corresponding expanded text will be taken automatically from the qualified name.

Also, because the OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElement has an implicit conversion from UAQualifiedName, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned UAQualifiedName (containing a target qualified name, which becomes the "any hierarchical" forward reference) in any place where OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElement is expected as input, and the corresponding OPC UA browse path element will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElement.FromUAQualifiedName static method instead.

Also, because the OpcLabs.EasyOpc.UA.UAReadParameters has an implicit conversions from UAQualifiedName, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply the returned UAQualifiedName (representing the name of the encoding to be used) in any place where OpcLabs.EasyOpc.UA.UAReadParameters is expected as input, and the corresponding OPC UA read parameters will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromDouble or FromUAQualifiedName static method instead.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

Because the UAQualifiedName 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 qualified name) in place of UAQualifiedName value when setting this property, and the corresponding OPC UA qualified name will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UAQualifiedName.UAQualifiedName Constructor(String) constructor instead.

This method or property does not throw any exceptions, aside from execution exceptions such as System.Threading.ThreadAbortException or System.OutOfMemoryException.

Requirements

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

Reference

UANodeElement Class
UANodeElement Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.