DANSrvAE Reference
EventAreaBrowser Class Members
See Also  Methods  Send comments on this topic.
NSPlugin Assembly > NSPlugin Namespace : EventAreaBrowser Class


Glossary Item Box

The following tables list the members exposed by EventAreaBrowser.

Public Constructors

 NameDescription
Public ConstructorEventAreaBrowser Constructor Default constructor.  
Top

Public Methods

 NameDescription
Public MethodBrowseOPCAreas Return a string array with a list of Areas as determined by the passed parameters. The position from which the browse is done can be set via the ChangeBrowsePosition.{br/> The returned enumerator may be empty if no Areas or Sources satisfied the filter constraints. The strings returned by the enumerator represent the Areas or Sources contained in the current level. They do not include ?? and delimiter or “parent” names. Clients are allowed to create and hold multiple enumerators in order to maintain more than one “browse position” at a time. Changing the browse position in one enumerator will not affect any other enumerator the client has created. The client must release each enumerator when finished with it.  
Public MethodChangeBrowsePositionProvides a way to move ‘up’ or ‘down’ in a hierarchical space from the current position, or a way to move to a specific position in the area space tree. The target string must represent an area, rather than a source.
An error is returned if the passed string does not represent an area. Moving ‘up’ from the ‘root’ shall return E_FAIL.  
Public MethodEquals (Inherited from object)
Public MethodGetHashCodeServes as the default hash function. (Inherited from object)
Public MethodGetQualifiedAreaNameProvides a mechanism to assemble a fully qualified Area name in a hierarchical space. This is required since at each point one is browsing just the names below the current node.
The server must return strings that can be added to the areaList for the EventSubscriptionMgt::SetFilter method, and can be used in the EventAreaBrowser.ChangeBrowsePosition method to move to a specific place in the process area space tree.  
Public MethodGetQualifiedSourceNameProvides a mechanism to assemble a fully qualified Source name in a hierarchical space. This is required since at each point one is browsing just the names below the current node.
The server must return strings that can be added to sources for the EventServer.EnableConditionBySource method.  
Public MethodGetTypeGets the System.Type of the current instance. (Inherited from object)
Public MethodonBrowseOPCAreas  
Public MethodonChangeBrowsePosition  
Public MethodonGetQualifiedAreaName  
Public MethodonGetQualifiedSourceName  
Public MethodRemove The object is released. Do any cleanup necessary.  
Public MethodToStringReturns a string that represents the current object. (Inherited from object)
Top

Protected Methods

 NameDescription
Protected MethodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from object)
Protected MethodMemberwiseCloneCreates a shallow copy of the current System.Object. (Inherited from object)
Top

See Also

© 2004-2017 Advosol Inc. All Rights Reserved.