Methods: Proficy_SOE.SOEView Control

ExecuteCommand

Purpose

Send a command name as a string, including one or more of the following parameters.

 

Syntax

Function ExecuteCommand(CommandName As String, ParamArray Parameters() As Variant) As Boolean

 

Parameters

Parameter

Description

 

 

Acknowledge

Acknowledge the current selected alarm.

 

 

DisplayHyperlinksCommand

Show/hide hyperlinks.

 

 

DetailPanelVisibleCommand

Show/hide the Detail panel.

 

 

ExpandedTreeOnloadCommand

Expand/do not expand tree when load sheet.

 

 

FindEventDialog

Open a Find Event dialog box.

 

 

FindTimeDialog

Open a Find Time dialog box.

 

 

Print

Print the SOEView display.

 

 

ReturntoRealtimeMode

Change back from Search mode to Real time mode.

 

 

RestartSOE

Restart the Proficy_SOE.SOEView display.

 

 

SetSelectedAsRoot

Set the currently selected event type in the tree as the root of tree.

 

 

SearchforAlarms

Open a Search dialog box.

 

 

SearchforDowntimeEvents

Open a Search dialog box.

 

 

SearchforProductChanges

Open a Search dialog box.

 

 

SearchforProductionEvents

Open a Search dialog box.

 

 

SearchforUserDefinedEvents

Open a Search dialog box.

 

 

SearchforWasteEvents

Open a Search dialog box.

 

 

ShowAddUDEScreen

Open a User Defined Event form.

 

 

ShowPopupFilter

Open a Filter dialog box.

 

 

SummaryPanelVisibleCommand

Show/hide a Summary panel.

 

 

ViewDisplayOptions

Open a Display Options dialog box.

 

 

ViewTimeline

Open a Timeline Web report.

HideTreeColumns

Purpose

Show/hide Tree columns.

 

Syntax

Sub HideTreeColumns(LocalArray() As String)

ParentClosing

Purpose

Internal use only.

 

Syntax

Function ParentClosing() As Boolean

SetSheetName

Purpose

Internal use only.

 

Syntax

Sub SetSheetName(s As String, [flgLoadTree As Boolean = True])

Shutdown

Purpose

ALWAYS USE Shutdown when you have finished using the control.

 

Syntax

Sub Shutdown()

Startup

Purpose

Start the control.

Note: The parameters are optional. If they are not defined the control looks for the information in the following order.

  1. In the registry for the current user.

  2. If the user is not found the control will prompt you to connect.

 

Syntax

Function Startup([ServerName As String], [UserName As String], [Password As String]) As Boolean

Top