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


Glossary Item Box

The following tables list the members exposed by ShowBrowseTree.

Public Constructors

 NameDescription
Public ConstructorShowBrowseTree Constructor Constructor. An object is created for the given OPC server and the Forms TreeView control. No OPC server access is done in this constructor. The Show() method needs to be called to have the server browsed and the result displayed in the specified control.  
Top

Public Properties

 NameDescription
Public PropertyAccessRightsFilter Filter for read/write access rights. The value 0 returns all items.  
Public PropertyBrowseModeOneLevel If true the the server browsing is done on demand. Initially only one 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 PropertyDataTypeFilter Data type used in the the OPC server browse calls. The default is void (VT_EMPTY). A different type needs to be set before the Browse method is called.  
Public PropertyDoNotSort Branches and items are alphabetically sorted. If TRUE the sorting is diabled and the branches/items are in the order as returned by the server.  
Public PropertyImageIndexBranch Index of the image displayed for a branch  
Public PropertyImageIndexBranchSelected Index of the image displayed for the selected branch  
Public PropertyImageIndexItem Base Index of the image group the item identification. The item accessRight code is added and the image with this index is displayed.  
Public PropertyImageList Image list used in the BrowsTree  
Public PropertyItemCodeIndexCode used to identify items and branches in TreeNode.ImageIndex
The isBranchand isItem methods use thye definition to find the type of the node.
Default: Item: >= 2
 
Public PropertyItemTree  
Public PropertyNameFilter Name filter used in the the OPC server browse calls. The default is NULL. A different filter string needs to be set before the Browse method is called.  
Top

Public Methods

 NameDescription
Public MethodDispose The underlying BrowseTree object is released and the event handler for the associated TreeView dialog is uninstalled.  
Public MethodisBranch Checks if a node is a branch or an item.  
Public MethodisItem Checks if a node is an item or a branch  
Public MethodItemName Get the full name of the item/branch in the specified branch. This method is typically used to get the name of the node selcted in a treeView.  
Public MethodRefreshSelectedBranch The currently selected branch is refreshed from the server by executing a browse with the current filter.  
Public MethodShow Browses the server and display the branches and items in a TreeView control.  
Public MethodShowImageList Show all images defined in the associated ImageList  
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 EventreportBrowseError This handler is called in the TreeView mouse event handler when an error happens in the server browse access.  
Top

See Also

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