ShowWaterExplorer

<< Click to Display Table of Contents >>

 

ShowWaterExplorer

ShowWaterExplorer(Title, RootObject, [Left], [Top], [ReadOnly], [ScreenObject], [BKColor], [ShowObjHierarchy])

Displays a window with all Analog and Discrete Measurements, Commands, and Protections of the selected object. This method's parameters are listed on the next table.

Parameters of the ShowWaterExplorer method

Parameter

Description

Title

Determines a window's title. Corresponds to WaterExplorer object's Title property

RootObject

Data device's path

Left

Window's horizontal coordinate, in pixels. Please check WaterExplorer object's SetWindowPlacement method for more information about this parameter's behavior, if omitted

Top

Window's vertical coordinate, in pixels. Please check WaterExplorer object's SetWindowPlacement method for more information about this parameter's behavior, if omitted

ReadOnly

Allows changing or not Measurement values with the ActiveSource property equal to 2 - Operator (Discrete or Analog), and also sending Commands. Corresponds to WaterExplorer object's ReadOnly property. If omitted, allows changing Measurement values and sending Commands

ScreenObject

Informs the graphical object associated to this method, highlighting its terminals. Corresponds to WaterExplorer object's ScreenObject property. If omitted, does not associate the window of a WaterExplorer object to any graphical object

BKColor

Background color of the Display containing Measurement and Command values. Corresponds to WaterExplorer object's DisplayBkColor property. If omitted, uses Windows default background color

ShowObjHierarchy

Indicates whether a tree must be displayed with the hierarchy of child objects of the object that called the WaterExplorer object. Corresponds to WaterExplorer object's ShowObjectHierarchy property. If omitted, does not display a tree with the hierarchy of child objects

 

The next code contains a usage example of this method.

Sub CommandButton_Click()
  Application.ShowWaterExplorer "Pump 1",_
    "System1.Station1.Pump1", 100, 100, False,_
    Screen.Item("Pump1"), RGB(0,0,0), False
End Sub

 

NOTE

PowerExplorer object's properties can be configured in the object returned by Viewer's GetWaterExplorer method.

Was this page useful?