Click or drag to resize

BrowseItemBase Class

Base implmentation of IBrowseItem.
Inheritance Hierarchy

Namespace: Demo3D.PLC.Comms
Assembly: PLC (in PLC.dll) Version: 19.00.00
Syntax
C#
Copy
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public class BrowseItemBase : StringAddress, 
	IBrowseItem, IAddress, IEquatable<IAddress>, IBrowseItemDescription, 
	INotifyPropertyChanged

The BrowseItemBase type exposes the following members.

Constructors
 NameDescription
Public methodBrowseItemBase Constructs a new root branch.
Public methodBrowseItemBase(IBrowseItem, String, Boolean, Boolean) Constructs a new browse item.
Public methodBrowseItemBase(IBrowseItem, String, String, Boolean, Boolean) Constructs a new browse item.
Top
Properties
 NameDescription
Public propertyAccessName The address used to access the item from the PLC.
(Inherited from StringAddress)
Protected propertyAllowDeepSearch When searching for an item by AccessName, defines whether to deep search the symbol table.
Public propertyAllowedAccess The access defined by this address.
(Inherited from StringAddress)
Public propertyDescription Description / comment for this browse item node.
Public propertyDescriptiveName A descriptive name (shown in the Tag Server Explorer), or null to use Name.
Public propertyIsBranch Returns true if this item has children and can be expanded.
Public propertyIsItem Returns true if this item can be loaded.
Public propertyName The name of this browse item node.
Top
Methods
 NameDescription
Public methodEquals(IAddress) Determines whether the address equals the current address.
(Inherited from StringAddress)
Public methodEquals(Object) Determines whether the specified address equals the current address.
(Inherited from StringAddress)
Public methodEquals(StringAddress) Determines whether the address equals the current address.
(Inherited from StringAddress)
Public methodFindChild Find a child by itemName or accessName.
Public methodGetChildren Return children of a branch item.
Public methodGetDataType Returns the type defined by this address.
(Inherited from StringAddress)
Public methodGetHashCode Computes a hash code for this address.
(Inherited from StringAddress)
Public methodToString Returns a string that represents the current browse item.
(Overrides StringAddressToString)
Top
Fields
 NameDescription
Protected fieldaccessName A cache of the string representation of the address.
(Inherited from StringAddress)
Protected fieldchildren Access to the list of child browse items.
Public fieldStatic memberNoChildren A template to return from GetChildren(BrowseFlags) if there are no children.
Public fieldStatic memberNull The null browse item. No name, not accessible, no children.
Top
Extension Methods
 NameDescription
Public Extension MethodAssociatedServerItem Gets one ServerItem corresponding to a browseItem.
(Defined by BrowseItemExtensions)
Public Extension MethodFindChild Finds a child item with the given name.
(Defined by BrowseItemExtensions)
Public Extension MethodFullName Returns the full (usually dot separated) name.
(Defined by BrowseItemExtensions)
Public Extension MethodIOSymbol Returns the CIP IOSymbol for a symbol table browseItem.
(Defined by IOSymbolExtensions)
Public Extension MethodIsAllLoaded Gets a value indicating whether all items from the browseItem have been loaded.
(Defined by BrowseItemExtensions)
Public Extension MethodIsAnyLoadable Gets a value indicating whether any item, or sub-items, can be loaded.
(Defined by BrowseItemExtensions)
Public Extension MethodIsAnyLoaded Gets a value indicating whether any items from the branch have been loaded.
(Defined by BrowseItemExtensions)
Public Extension MethodPLCSymbol Returns the CIP PLCSymbol for a symbol table browseItem.
(Defined by PLCSymbolExtensions)
Public Extension MethodSiblingServerItems Gets all sibling server items belonging to this browseItem.
(Defined by BrowseItemExtensions)
Public Extension MethodTreatAsItem Gets a value indicating whether this branch should be treated as an item.
(Defined by BrowseItemExtensions)
Top
See Also