BrowseItemBase Class |
Base implmentation of IBrowseItem.
Inheritance HierarchySystemObject
Demo3D.PLC.CommsStringAddress
Demo3D.PLC.CommsBrowseItemBase
Demo3D.HLE.Comms.TelegramTelegramSymbol
Demo3D.PLC.CommsBrowseItemBranch
Demo3D.PLC.Comms.BuiltinSymbol
Demo3D.PLC.CommsStringAddress
Demo3D.PLC.CommsBrowseItemBase
Demo3D.HLE.Comms.TelegramTelegramSymbol
Demo3D.PLC.CommsBrowseItemBranch
Demo3D.PLC.Comms.BuiltinSymbol
Namespace: Demo3D.PLC.Comms
Assembly: PLC (in PLC.dll) Version: 15.0.2.11458
SyntaxC#
[TypeConverterAttribute(typeof(ExpandableObjectConverter))] public class BrowseItemBase : StringAddress, IBrowseItem, IAddress, IEquatable<IAddress>, IBrowseItemDescription
The BrowseItemBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BrowseItemBase |
Constructs a new root branch.
|
| BrowseItemBase(IBrowseItem, String, Boolean, Boolean) |
Constructs a new browse item.
|
| BrowseItemBase(IBrowseItem, String, String, Boolean, Boolean) |
Constructs a new browse item.
|
Properties| Name | Description | |
|---|---|---|
 | AccessName |
The address used to access the item from the PLC.
(Inherited from StringAddress.) |
 | AllowDeepSearch |
When searching for an item by AccessName, defines whether to deep search the symbol table.
|
| AllowedAccess |
The access defined by this address.
(Inherited from StringAddress.) |
| Description |
Description / comment for this browse item node.
|
| DescriptiveName |
A descriptive name (shown in the Tag Server Explorer), or null to use Name.
|
| IsBranch |
Returns true if this item has children and can be expanded.
|
| IsItem |
Returns true if this item can be loaded.
|
| Name |
The name of this browse item node.
|
| Parent |
The parent of this browse item.
|
Methods| Name | Description | |
|---|---|---|
| Equals(IAddress) |
Determines whether the address equals the current address.
(Inherited from StringAddress.) |
| Equals(Object) |
Determines whether the specified address equals the current address.
(Inherited from StringAddress.) |
| Equals(StringAddress) |
Determines whether the address equals the current address.
(Inherited from StringAddress.) |
| FindChild |
Defaults to FindChildByAccessName.
|
| GetChildren |
Return children of a branch item.
|
| GetDataType |
Returns the type defined by this address.
(Inherited from StringAddress.) |
| GetHashCode |
Computes a hash code for this address.
(Inherited from StringAddress.) |
| ToString |
Returns a string that represents the current browse item.
(Overrides StringAddressToString.) |
Fields| Name | Description | |
|---|---|---|
 | accessName |
A cache of the string representation of the address.
(Inherited from StringAddress.) |
| children |
Access to the list of child browse items.
|
  | NoChildren |
A template to return from GetChildren(BrowseFlags) if there are no children.
|
| Null |
The null browse item. No name, not accessible, no children.
|
Extension Methods| Name | Description | |
|---|---|---|
 | AssociatedServerItem |
Gets one ServerItem corresponding to a browseItem.
(Defined by BrowseItemExtensions.) |
| FindChild |
Finds a child item with the given name.
(Defined by BrowseItemExtensions.) |
| FullName |
Returns the full (usually dot separated) name.
(Defined by BrowseItemExtensions.) |
| GetDataType |
Returns the type defined by this address.
(Defined by AddressExtensions.) |
| IsAllLoaded |
Gets a value indicating whether all items from the browseItem have been loaded.
(Defined by BrowseItemExtensions.) |
| IsAnyLoadable |
Gets a value indicating whether any item, or sub-items, can be loaded.
(Defined by BrowseItemExtensions.) |
| IsAnyLoaded |
Gets a value indicating whether any items from the branch have been loaded.
(Defined by BrowseItemExtensions.) |
| SiblingServerItems |
Gets all sibling server items belonging to this browseItem.
(Defined by BrowseItemExtensions.) |
| ToString(Type) | Overloaded.
Return string representation using the format for asAddressType.
(Defined by AddressExtensions.) |
| ToStringT | Overloaded.
Return string representation using the format for T.
(Defined by AddressExtensions.) |
| TreatAsItem |
Gets a value indicating whether this branch should be treated as an item.
(Defined by BrowseItemExtensions.) |
See Also