This is a modal dialog box; therefore, when shown, it blocks the rest of the application until the user has made a choice. When a dialog box is displayed modally, no input (keyboard or mouse click) can occur except to objects on the dialog box. The program must hide or close the dialog box (usually in response to some user action) before input to the calling program can occur.

General

Icon:

If you do not know upfront which OPC-UA server and its endpoint to connect to, and do not have this information from any other source, your application will need to allow the user select the OPC server(s) to work with. The OPC-UA Endpoint Dialog (UAEndpointDialog class) allows the user to select the OPC server and its endpoint interactively from the list of OPC Unified Architecture servers provided by a LDS (Local Discovery Server) installed on a machine.

Here is an example of OPC-UA Endpoint dialog in action:

To run the dialog, call the ShowDialog method. If the result is equal to DialogResult.OK, the user has selected the OPC UA server, and information about it can be retrieved from the DiscoveryElement property.

Currently, the dialog shows endpoint provided by a LDS (Local Discovery Server) that you set by a static property on the EasyUAClient object. This approach may change in future.

.NET

// This example shows how to let the user browse for an OPC-UA server endpoint.
//
// Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

using System.Windows.Forms;
using OpcLabs.EasyOpc.UA.Forms.Browsing;

namespace UAFormsDocExamples._UAEndpointDialog
{
    static class ShowDialog
    {
        public static void Main1(IWin32Window owner)
        {
            var endpointDialog = new UAEndpointDialog
            {
                DiscoveryHost = "opcua.demo-this.com"
            };

            DialogResult dialogResult = endpointDialog.ShowDialog(owner);
            if (dialogResult != DialogResult.OK)
                return;

            // Display results
            MessageBox.Show(owner, endpointDialog.DiscoveryElement.ToString());
        }
    }
}

# This example shows how to let the user browse for an OPC-UA server endpoint.
#
# Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

using namespace OpcLabs.EasyOpc.UA.Forms.Browsing

# The path below assumes that the current directory is [ProductDir]/Examples-NET/PowerShell/Windows .
Add-Type -Path "../../../Components/Opclabs.QuickOpc/net472/OpcLabs.EasyOpcForms.dll"

# Instantiate the dialog object.
$endpointDialog = New-Object UAEndpointDialog
$endpointDialog.DiscoveryHost = "opcua.demo-this.com"

$dialogResult = $endpointDialog.ShowDialog()
if ($dialogResult -ne [System.Windows.Forms.DialogResult]::OK) {
    return
}

# Display results
Write-Host $endpointDialog.DiscoveryElement

# This example shows how to let the user browse for an OPC-UA server endpoint.
#
# Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .
# OPC client and subscriber examples in Python on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-Python .
# The QuickOPC package is needed. Install it using "pip install opclabs_quickopc".
import opclabs_quickopc

# Import .NET namespaces.
from System.Windows.Forms import *
from OpcLabs.EasyOpc.UA.Forms.Browsing import *


endpointDialog = UAEndpointDialog()
endpointDialog.DiscoveryHost = 'opcua.demo-this.com'

dialogResult = endpointDialog.ShowDialog()
print(dialogResult)
if dialogResult != DialogResult.OK:
    exit()

# Display results.
print(endpointDialog.DiscoveryElement)

print('Finished.')

' This example shows how to let the user browse for an OPC-UA server endpoint.
'
' Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

Imports OpcLabs.EasyOpc.UA.Forms.Browsing

Namespace UAFormsDocExamples._UAEndpointDialog
    Friend Class ShowDialog
        Shared Sub Main1(owner As IWin32Window)
            Dim endpointDialog = New UAEndpointDialog() With {
                .DiscoveryHost = "opcua.demo-this.com"
                }

            Dim dialogResult As DialogResult = endpointDialog.ShowDialog(owner)
            If dialogResult <> DialogResult.OK Then
                Return
            End If

            ' Display results
            MessageBox.Show(owner, endpointDialog.DiscoveryElement.ToString())
        End Sub
    End Class
End Namespace

COM

// This example shows how to let the user browse for an OPC-UA server endpoint.
//
// Find all latest examples here : https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

#include "stdafx.h"    // Includes "QuickOpc.h", and other commonly used files
#include "ShowDialog.h"

namespace _UAEndpointDialog
{
    void ShowDialog1::Main()
    {
        // Initialize the COM library
        CoInitializeEx(NULL, COINIT_MULTITHREADED);
        {
            // 
            _UAEndpointDialogPtr EndpointDialogPtr(__uuidof(UAEndpointDialog));

            //
            EndpointDialogPtr->DiscoveryHost = L"opcua.demo-this.com";

            // 
            DialogResult dialogResult = EndpointDialogPtr->ShowDialog(NULL);
            _tprintf(_T("%d\n"), dialogResult);

            if (dialogResult == 1/*OK*/)
            {
                // Display results
                _tprintf(_T("%s\n"), (LPCTSTR)CW2CT(EndpointDialogPtr->DiscoveryElement->ToString));
            }
        }
         // Release all interface pointers BEFORE calling CoUninitialize()
        CoUninitialize();
    }
}

// This example shows how to let the user browse for an OPC-UA server endpoint.
//
// Find all latest examples here : https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

class procedure ShowDialog.Main;
var
  EndpointDialog: UAEndpointDialog;
begin
  // Instantiate the dialog object
  EndpointDialog := CoUAEndpointDialog.Create;

  EndpointDialog.DiscoveryHost := 'opcua.demo-this.com';

  EndpointDialog.ShowDialog(nil);
  // IMPROVE: check the dialog result

  // Display results
  WriteLn(EndpointDialog.DiscoveryElement.ToString);
end;

// This example shows how to let the user browse for an OPC-UA server endpoint.
//
// Find all latest examples here : https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

class procedure ShowDialog.Main;
var
  EndpointDialog: OpcLabs_EasyOpcForms_TLB._UAEndpointDialog;
  DialogResult: System_Windows_Forms_TLB.DialogResult;
begin
  // Instantiate the dialog object
  EndpointDialog := CoUAEndpointDialog.Create;

  EndpointDialog.DiscoveryHost := 'opcua.demo-this.com';

  DialogResult := EndpointDialog.ShowDialog(nil);
  WriteLn(DialogResult);

  if DialogResult <> DialogResult_OK then
    Exit;

  // Display results
  WriteLn(EndpointDialog.DiscoveryElement.ToString);
end;

REM This example shows how to let the user browse for an OPC-UA server endpoint.
REM
REM Find all latest examples here : https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

Private Sub ShowDialog_Main_Command_Click()
    OutputText = ""

    Dim EndpointDialog As New UAEndpointDialog
    EndpointDialog.DiscoveryHost = "opcua.demo-this.com"
    
    Dim DialogResult
    DialogResult = EndpointDialog.ShowDialog
    
    OutputText = OutputText & DialogResult & vbCrLf
    If DialogResult <> 1 Then   ' OK
        Exit Sub
    End If
    
    ' Display results
    OutputText = OutputText & EndpointDialog.DiscoveryElement & vbCrLf
End Sub

Rem This example shows how to let the user browse for an OPC-UA server endpoint.
Rem
Rem Find all latest examples here : https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

Option Explicit

Const DialogResult_OK = 1

Dim EndpointDialog: Set EndpointDialog = CreateObject("OpcLabs.EasyOpc.UA.Forms.Browsing.UAEndpointDialog")
EndpointDialog.DiscoveryHost = "opcua.demo-this.com"

Dim dialogResult: dialogResult = EndpointDialog.ShowDialog
WScript.Echo dialogResult

If dialogResult <> DialogResult_OK Then
    WScript.Quit
End If

' Display results
WScript.Echo EndpointDialog.DiscoveryElement

Advanced

If you want to change the parameters of the client object the component uses to perform its OPC operations, you can use the ClientSelector Property.

.NET

COM

// This example shows how to let the user browse for an OPC-UA server endpoint.
//
// Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

using System.Windows.Forms;
using OpcLabs.EasyOpc.UA.Forms.Browsing;

namespace UAFormsDocExamples._UAEndpointDialog
{
    static class ShowDialog
    {
        public static void Main1(IWin32Window owner)
        {
            var endpointDialog = new UAEndpointDialog
            {
                DiscoveryHost = "opcua.demo-this.com"
            };

            DialogResult dialogResult = endpointDialog.ShowDialog(owner);
            if (dialogResult != DialogResult.OK)
                return;

            // Display results
            MessageBox.Show(owner, endpointDialog.DiscoveryElement.ToString());
        }
    }
}

# This example shows how to let the user browse for an OPC-UA server endpoint.
#
# Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

using namespace OpcLabs.EasyOpc.UA.Forms.Browsing

# The path below assumes that the current directory is [ProductDir]/Examples-NET/PowerShell/Windows .
Add-Type -Path "../../../Components/Opclabs.QuickOpc/net472/OpcLabs.EasyOpcForms.dll"

# Instantiate the dialog object.
$endpointDialog = New-Object UAEndpointDialog
$endpointDialog.DiscoveryHost = "opcua.demo-this.com"

$dialogResult = $endpointDialog.ShowDialog()
if ($dialogResult -ne [System.Windows.Forms.DialogResult]::OK) {
    return
}

# Display results
Write-Host $endpointDialog.DiscoveryElement

# This example shows how to let the user browse for an OPC-UA server endpoint.
#
# Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .
# OPC client and subscriber examples in Python on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-Python .
# The QuickOPC package is needed. Install it using "pip install opclabs_quickopc".
import opclabs_quickopc

# Import .NET namespaces.
from System.Windows.Forms import *
from OpcLabs.EasyOpc.UA.Forms.Browsing import *


endpointDialog = UAEndpointDialog()
endpointDialog.DiscoveryHost = 'opcua.demo-this.com'

dialogResult = endpointDialog.ShowDialog()
print(dialogResult)
if dialogResult != DialogResult.OK:
    exit()

# Display results.
print(endpointDialog.DiscoveryElement)

print('Finished.')

' This example shows how to let the user browse for an OPC-UA server endpoint.
'
' Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

Imports OpcLabs.EasyOpc.UA.Forms.Browsing

Namespace UAFormsDocExamples._UAEndpointDialog
    Friend Class ShowDialog
        Shared Sub Main1(owner As IWin32Window)
            Dim endpointDialog = New UAEndpointDialog() With {
                .DiscoveryHost = "opcua.demo-this.com"
                }

            Dim dialogResult As DialogResult = endpointDialog.ShowDialog(owner)
            If dialogResult <> DialogResult.OK Then
                Return
            End If

            ' Display results
            MessageBox.Show(owner, endpointDialog.DiscoveryElement.ToString())
        End Sub
    End Class
End Namespace

// This example shows how to let the user browse for an OPC-UA server endpoint.
//
// Find all latest examples here : https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

#include "stdafx.h"    // Includes "QuickOpc.h", and other commonly used files
#include "ShowDialog.h"

namespace _UAEndpointDialog
{
    void ShowDialog1::Main()
    {
        // Initialize the COM library
        CoInitializeEx(NULL, COINIT_MULTITHREADED);
        {
            // 
            _UAEndpointDialogPtr EndpointDialogPtr(__uuidof(UAEndpointDialog));

            //
            EndpointDialogPtr->DiscoveryHost = L"opcua.demo-this.com";

            // 
            DialogResult dialogResult = EndpointDialogPtr->ShowDialog(NULL);
            _tprintf(_T("%d\n"), dialogResult);

            if (dialogResult == 1/*OK*/)
            {
                // Display results
                _tprintf(_T("%s\n"), (LPCTSTR)CW2CT(EndpointDialogPtr->DiscoveryElement->ToString));
            }
        }
         // Release all interface pointers BEFORE calling CoUninitialize()
        CoUninitialize();
    }
}

// This example shows how to let the user browse for an OPC-UA server endpoint.
//
// Find all latest examples here : https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

class procedure ShowDialog.Main;
var
  EndpointDialog: OpcLabs_EasyOpcForms_TLB._UAEndpointDialog;
  DialogResult: System_Windows_Forms_TLB.DialogResult;
begin
  // Instantiate the dialog object
  EndpointDialog := CoUAEndpointDialog.Create;

  EndpointDialog.DiscoveryHost := 'opcua.demo-this.com';

  DialogResult := EndpointDialog.ShowDialog(nil);
  WriteLn(DialogResult);

  if DialogResult <> DialogResult_OK then
    Exit;

  // Display results
  WriteLn(EndpointDialog.DiscoveryElement.ToString);
end;

REM This example shows how to let the user browse for an OPC-UA server endpoint.
REM
REM Find all latest examples here : https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

Private Sub ShowDialog_Main_Command_Click()
    OutputText = ""

    Dim EndpointDialog As New UAEndpointDialog
    EndpointDialog.DiscoveryHost = "opcua.demo-this.com"
    
    Dim DialogResult
    DialogResult = EndpointDialog.ShowDialog
    
    OutputText = OutputText & DialogResult & vbCrLf
    If DialogResult <> 1 Then   ' OK
        Exit Sub
    End If
    
    ' Display results
    OutputText = OutputText & EndpointDialog.DiscoveryElement & vbCrLf
End Sub

Rem This example shows how to let the user browse for an OPC-UA server endpoint.
Rem
Rem Find all latest examples here : https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .

Option Explicit

Const DialogResult_OK = 1

Dim EndpointDialog: Set EndpointDialog = CreateObject("OpcLabs.EasyOpc.UA.Forms.Browsing.UAEndpointDialog")
EndpointDialog.DiscoveryHost = "opcua.demo-this.com"

Dim dialogResult: dialogResult = EndpointDialog.ShowDialog
WScript.Echo dialogResult

If dialogResult <> DialogResult_OK Then
    WScript.Quit
End If

' Display results
WScript.Echo EndpointDialog.DiscoveryElement

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         System.Windows.Forms.CommonDialog
            OpcLabs.BaseLib.Forms.ConcreteCommonDialog
               OpcLabs.BaseLib.Forms.FormCommonDialog
                  OpcLabs.BaseLib.Forms.SizableCommonDialog
                     OpcLabs.EasyOpc.UA.Forms.Browsing.UADialog
                        OpcLabs.EasyOpc.UA.Forms.Browsing.UAEndpointDialog

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