![](dotnetdiagramimages/OpcLabs_EasyOpcForms_OpcLabs_EasyOpc_UA_Forms_Browsing_UABrowseControl.png)
'Declaration
<ComVisibleAttribute(False)> <TypeConverterAttribute(System.ComponentModel.ExpandableObjectConverter)> <DesignerCategoryAttribute("UserControl")> <DefaultEventAttribute("Load")> <DefaultPropertyAttribute("Text")> <DesignerSerializerAttribute("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")> Public NotInheritable Class UABrowseControl Inherits OpcLabs.BaseLib.Forms.Browsing.Generalized.BrowseControl Implements System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.ComponentModel.ISynchronizeInvoke, System.IDisposable, System.Windows.Forms.IBindableComponent, System.Windows.Forms.IContainerControl, System.Windows.Forms.IDropTarget, System.Windows.Forms.IWin32Window
'Usage
Dim instance As UABrowseControl
[ComVisible(false)] [TypeConverter(System.ComponentModel.ExpandableObjectConverter)] [DesignerCategory("UserControl")] [DefaultEvent("Load")] [DefaultProperty("Text")] [DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] public sealed class UABrowseControl : OpcLabs.BaseLib.Forms.Browsing.Generalized.BrowseControl, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.ComponentModel.ISynchronizeInvoke, System.IDisposable, System.Windows.Forms.IBindableComponent, System.Windows.Forms.IContainerControl, System.Windows.Forms.IDropTarget, System.Windows.Forms.IWin32Window
[ComVisible(false)] [TypeConverter(System.ComponentModel.ExpandableObjectConverter)] [DesignerCategory("UserControl")] [DefaultEvent("Load")] [DefaultProperty("Text")] [DesignerSerializer("System.Windows.Forms.Design.ControlCodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")] public ref class UABrowseControl sealed : public OpcLabs.BaseLib.Forms.Browsing.Generalized.BrowseControl, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.ComponentModel.ISynchronizeInvoke, System.IDisposable, System.Windows.Forms.IBindableComponent, System.Windows.Forms.IContainerControl, System.Windows.Forms.IDropTarget, System.Windows.Forms.IWin32Window
// This example shows how to allow browsing for an OPC Unified Architecture node by placing a browsing control on the form. using System; using System.Windows.Forms; using OpcLabs.BaseLib; using OpcLabs.EasyOpc.UA.Forms.Browsing; namespace UAFormsDocExamples._UABrowseControl { public partial class UsageForm : Form { public UsageForm() { InitializeComponent(); } private void getOutputsButton_Click(object sender, EventArgs e) { // Obtain the current node element. UABrowseNodeElement currentNodeElement = uaBrowseControl1.Outputs.CurrentNodeElement; // Display the present parts of the current node element in the outputs text text box. outputsTextBox.Text = ""; if (!(currentNodeElement.HostElement is null)) outputsTextBox.Text += $"{nameof(UABrowseNodeElement.HostElement)}: {currentNodeElement.HostElement}\r\n"; if (!(currentNodeElement.DiscoveryElement is null)) outputsTextBox.Text += $"{nameof(UABrowseNodeElement.DiscoveryElement)}: {currentNodeElement.DiscoveryElement}\r\n"; if (!(currentNodeElement.NodeElement is null)) outputsTextBox.Text += $"{nameof(UABrowseNodeElement.NodeElement)}: {currentNodeElement.NodeElement}\r\n"; } private void uaBrowseControl1_BrowseFailure(object sender, FailureEventArgs e) { // Append the event name and its arguments to the browsing events text box. browsingEventsTextBox.Text += $"{nameof(UABrowseControl.BrowseFailure)}: {e}\r\n"; } private void uaBrowseControl1_CurrentNodeChanged(object sender, EventArgs e) { // Append the event name and the current node element to the browsing events text box. browsingEventsTextBox.Text += $"{nameof(UABrowseControl.CurrentNodeChanged)}; {uaBrowseControl1.Outputs.CurrentNodeElement}\r\n"; } private void uaBrowseControl1_NodeDoubleClick(object sender, EventArgs e) { // Append the event name to the browsing events text box. browsingEventsTextBox.Text += $"{nameof(UABrowseControl.NodeDoubleClick)}\r\n"; } private void uaBrowseControl1_SelectionChanged(object sender, EventArgs e) { // Append the event name to the browsing events text box. browsingEventsTextBox.Text += $"{nameof(UABrowseControl.SelectionChanged)}\r\n"; } private void setInputsButton_Click(object sender, EventArgs e) { // Set the current node to our pre-defined OPC UA server. uaBrowseControl1.InputsOutputs.CurrentNodeDescriptor.EndpointDescriptor = "opc.tcp://opcua.demo-this.com:51210/UA/SampleServer"; } } }
namespace UAFormsDocExamples._UABrowseControl { partial class UsageForm { /// <summary> /// Required designer variable. /// </summary> private System.ComponentModel.IContainer components = null; /// <summary> /// Clean up any resources being used. /// </summary> /// <param name="disposing">true if managed resources should be disposed; otherwise, false.</param> protected override void Dispose(bool disposing) { if (disposing && (components != null)) { components.Dispose(); } base.Dispose(disposing); } #region Windows Form Designer generated code /// <summary> /// Required method for Designer support - do not modify /// the contents of this method with the code editor. /// </summary> private void InitializeComponent() { this.uaBrowseControl1 = new OpcLabs.EasyOpc.UA.Forms.Browsing.UABrowseControl(); this.setInputsButton = new System.Windows.Forms.Button(); this.getOutputsButton = new System.Windows.Forms.Button(); this.label1 = new System.Windows.Forms.Label(); this.outputsTextBox = new System.Windows.Forms.TextBox(); this.browsingEventsTextBox = new System.Windows.Forms.TextBox(); ((System.ComponentModel.ISupportInitialize)(this.uaBrowseControl1)).BeginInit(); this.SuspendLayout(); // // uaBrowseControl1 // this.uaBrowseControl1.Location = new System.Drawing.Point(13, 42); this.uaBrowseControl1.MinimumSize = new System.Drawing.Size(135, 150); this.uaBrowseControl1.Name = "uaBrowseControl1"; this.uaBrowseControl1.Size = new System.Drawing.Size(450, 300); this.uaBrowseControl1.TabIndex = 0; this.uaBrowseControl1.BrowseFailure += new OpcLabs.BaseLib.FailureEventHandler(this.uaBrowseControl1_BrowseFailure); this.uaBrowseControl1.CurrentNodeChanged += new System.EventHandler(this.uaBrowseControl1_CurrentNodeChanged); this.uaBrowseControl1.NodeDoubleClick += new System.EventHandler(this.uaBrowseControl1_NodeDoubleClick); this.uaBrowseControl1.SelectionChanged += new System.EventHandler(this.uaBrowseControl1_SelectionChanged); // // setInputsButton // this.setInputsButton.Location = new System.Drawing.Point(13, 13); this.setInputsButton.Name = "setInputsButton"; this.setInputsButton.Size = new System.Drawing.Size(75, 23); this.setInputsButton.TabIndex = 1; this.setInputsButton.Text = "&Set inputs"; this.setInputsButton.UseVisualStyleBackColor = true; this.setInputsButton.Click += new System.EventHandler(this.setInputsButton_Click); // // getOutputsButton // this.getOutputsButton.Location = new System.Drawing.Point(13, 349); this.getOutputsButton.Name = "getOutputsButton"; this.getOutputsButton.Size = new System.Drawing.Size(75, 23); this.getOutputsButton.TabIndex = 2; this.getOutputsButton.Text = "&Get outputs"; this.getOutputsButton.UseVisualStyleBackColor = true; this.getOutputsButton.Click += new System.EventHandler(this.getOutputsButton_Click); // // label1 // this.label1.AutoSize = true; this.label1.Location = new System.Drawing.Point(481, 42); this.label1.Name = "label1"; this.label1.Size = new System.Drawing.Size(88, 13); this.label1.TabIndex = 3; this.label1.Text = "&Browsing events:"; // // outputsTextBox // this.outputsTextBox.Location = new System.Drawing.Point(13, 379); this.outputsTextBox.Multiline = true; this.outputsTextBox.Name = "outputsTextBox"; this.outputsTextBox.ReadOnly = true; this.outputsTextBox.Size = new System.Drawing.Size(951, 59); this.outputsTextBox.TabIndex = 4; // // browsingEventsTextBox // this.browsingEventsTextBox.Location = new System.Drawing.Point(484, 59); this.browsingEventsTextBox.Multiline = true; this.browsingEventsTextBox.Name = "browsingEventsTextBox"; this.browsingEventsTextBox.ReadOnly = true; this.browsingEventsTextBox.Size = new System.Drawing.Size(480, 283); this.browsingEventsTextBox.TabIndex = 5; // // UsageForm // this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F); this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; this.ClientSize = new System.Drawing.Size(976, 450); this.Controls.Add(this.browsingEventsTextBox); this.Controls.Add(this.outputsTextBox); this.Controls.Add(this.label1); this.Controls.Add(this.getOutputsButton); this.Controls.Add(this.setInputsButton); this.Controls.Add(this.uaBrowseControl1); this.Name = "UsageForm"; this.Text = "UsageForm"; ((System.ComponentModel.ISupportInitialize)(this.uaBrowseControl1)).EndInit(); this.ResumeLayout(false); this.PerformLayout(); } #endregion private OpcLabs.EasyOpc.UA.Forms.Browsing.UABrowseControl uaBrowseControl1; private System.Windows.Forms.Button setInputsButton; private System.Windows.Forms.Button getOutputsButton; private System.Windows.Forms.Label label1; private System.Windows.Forms.TextBox outputsTextBox; private System.Windows.Forms.TextBox browsingEventsTextBox; } }
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
System.Windows.Forms.Control
System.Windows.Forms.ScrollableControl
System.Windows.Forms.ContainerControl
System.Windows.Forms.UserControl
OpcLabs.BaseLib.Forms.Browsing.Generalized.BrowseControl
OpcLabs.EasyOpc.UA.Forms.Browsing.UABrowseControl
The generic OPC UA browsing control is represented by the UABrowseControl Class (in Windows Forms) or by the WpfUABrowseControl Class (in WPF).
With it, your forms can integrate a control with various OPC nodes from which the user can select. This control can be configured to serve many different purposes.
Here is an example of the generic OPC browsing control in action:
The functionality and properties of the UABrowseControl or WpfUABrowseControl are similar to that of UABrowseDialog, described earlier in this text. Please refer to the documentation of UABrowseDialog for details. Here are the major differences:
Using the Kind property, the browsing control can be configured to provide a tree view only (BrowseControlKinds.Tree), a list view only (BrowseControlKinds.List), or a combined tree view and list view (BrowseControlKinds.TreeAndList; this is the default).
The View property (of System.Windows.Forms.View enumeration type) controls how the list view items are displayed. Possible values are LargeIcon, Details (the default), SmallIcon, List, or Tile.
In order to achieve tight integration with other controls on your form, you can hook to events that the browsing control provides.
The CurrentNodeChanged event occurs when the current node changes. You can obtain the information about the new current node from InputsOutputs.CurrentNodeDescriptor and Outputs.CurrentNodeElement properties inside the event handler.
The SelectionChanged event is meant for multi-selection mode, and occurs when the selection set changes. You can obtain the information about the new selection set from InputsOutputs.SelectionDescriptors and Outputs.SelectionElements collections inside the event handler.
The NodeDoubleClick event occurs when a node is double-clicked. This is the current node, and therefore the information about it can be obtained in the same way as in the CurrentNodeChanged event handler, described above.
The BrowseFailure event indicates that an exception has occurred during browsing. The information about the exception is contained in the event arguments.
In Windows Forms, the generic OPC UA browsing control is represented by the UABrowseControl Class, which is implemented directly in the Windows Forms technology. There is also a corresponding icon in the Visual Studio Toolbox that you drag onto a design surface of your forms or user control.
In WPF (Windows Presentation Foundation), the generic OPC UA browsing control is represented by the WpfUABrowseControl Class, which is implemented as a WPF wrapper arround the Windows Forms control (UABrowseControl). There is also a corresponding icon in the Visual Studio Toolbox that you drag onto a design surface of your window.
If you want to change the parameters of the client objects the component uses to perform its OPC operations, you can use the ClientSelector Property.