OPCDA.NET Reference Manual
BGBrowseTree Class Members
See Also  Fields  Properties  Methods  Events Send Feedback
OpcDaNetUA.Net4 Assembly > OPCDA.NET Namespace : BGBrowseTree Class


Glossary Item Box

The following tables list the members exposed by BGBrowseTree.

Public Constructors

 NameDescription
Public ConstructorBGBrowseTree ConstructorOverloaded.   
Top

Public Fields

 NameDescription
Public FieldTag Object for optional application specific data  
Top

Public Properties

 NameDescription
Public PropertyBrowseModeOneLevel If true the the server browsing is done on demand. Initially only the root level is browsed. Sub-branches are browsed from the TreeView event handler when a yet unbrowsed branch is selected. If false then the whole server tree structure is browsed and a corresponding TreeNode structure is built. NOTE: With complex servers this may take a long time.  
Public PropertyDoNotSort Branches and items are alphabetically sorted. If TRUE the sorting is diabled and the branches/items are displayed in the order as returned by the server.  
Public PropertyFilterAccessRights Access rights browse filter. The default UNKNOWN (0) and READWRITE (3) matches all items. READ (1) matches all items that are readable. WRITE (2) matches all items that are writable.  
Public PropertyFilterDatatype Item canonical data type filter. The default is to include all items. This is specified as: C# : typeof(void) VB : Type.GetType("System.Void") If another type is defined then only items with this canonical data type are included in the browse result.  
Public PropertyFilterName Item name browse filter. An empty string (the default) or "*" matches all names.  
Public PropertyPropertyIDsToGet IDs of the item properties to read with the browse. By default the properties 1 (Canonical Datatype) and 5 (Item access rights) are defined. The access right property value is used for the image selection in the TreeView control. Property 5 should always be part of a user defined set of properties.  
Top

Public Methods

 NameDescription
Public MethodBrowseAvailable in the OPCDA.NET Professional Edition only.
The server is browsed according the current state of the properties of this object and the handling depends on the constructor overload used to create the object. The browse result is filtered according the state of the filter properties. The FilterName property is applied for branches and items. The FilterAccressRights and FilterDatatype proeprties only for items.  
Public MethodDisposeAvailable in the OPCDA.NET Professional Edition only.
Dispose needs to be called to remove the object from the TreeView control. The MouseDown and AfterSelect TreeView control event handlers are uninstalled.  
Public MethodisBranch Checks if a node is a branch. The node may also be a item in OPC DA V3 servers.  
Public MethodisItem Checks if a node is an item. The node may also be a branch in OPC DA V3 servers.  
Public MethodRefreshCurrentBranch The currently selected branch is refreshed from the server by executing a browse with the current filter.  
Top

Protected Methods

 NameDescription
Protected MethodFinalize  
Top

Public Events

 NameDescription
Public EventgetBrowseFilter This handler is called everytime the OPC server BrowseItemIDs method is called to get the browse filters to be used.  
Public EventNotifications Reports browse completion and errors  
Public EventNotificationsExt Reports browse completion and errors, including with BGServer object related to the event.  
Top

See Also

Copyright © 2002-2018 Advosol Inc. All Rights Reserved.