Methods: Proficy_ALM.AlarmView Control

AckFromDialog

	Purpose	Send an acknowledgment message for the specified alarm ID.
	Syntax	Sub AckFromDialog(AlarmId As Long)

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 a currently selected alarm.
	AddTrend	Open a trend of the currently selected variable.
	AlarmAnalysis	Open an Analysis window for the currently selected variable.
	ClearControl	Shut down the Alarm display.
	CommentWindowCommand	Open the Comment window.
	DisplayActionCommentSubtext	Display Action comment subtext.
	DisplayCauseCommentSubtext	Display Cause comment subtext.
	DisplayHyperLinksCommand	Display hyperlinks.
	DisplayResearchCommentSubtext	Display Research comment subtext.
	DisplayTemplateCommentSubtext	Display Template comment subtext.
	DisplayVariableCommentSubtext	Display Variable comment subtext.
	DoNotDisplaySubtext	Turn off comments subtext.
	FilterOnly	Open a Filter dialog box to enter filter criteria. Change the display to Filter Only mode. Display only alarms allowed by the criteria.
	FindTimeDialog	Open a Find Time dialog box.
	Print	Print the AlarmView display.
	QueryWizard	Change the display to Query mode. Open a Search dialog to enter alarm search criteria. Display alarms that fulfill the criteria.
	QuickSearchSimilarAlarms	Display a quick on screen query to find and display alarms that are similar to alarms for the currently selected row.
	ReturnToRealTimeMode	Change back from Query mode to Real time mode.
	SortByPriority	Sort alarm rows by priority
	SortByAcknowledgement	Sort alarm rows by acknowledgement.
	SortByTime	Sort alarm rows by time.
	ViewDisplayOptions	Open a Display Options dialog box.
	ViewTimeline	Open a Timeline Web report.

FilterSpecial

Purpose	Display an ad hoc view of alarms based on the specified parameters. For example:
	If:	All of the parameters are used. IsUnit is True ID, ST (start time) and ET (End time) are specified,
	Then:	The filter looks for alarms triggered for the Unit ID within the specified start to end times. Only the alarms that fit the criteria display. If no alarms fit the criteria, the display is blank.
Syntax	Sub FilterSpecial(Id As Long, IsUnit As Boolean, ST As Date, ET As Date)

RaiseTrendFromDialog

	Purpose	Internal use by the Proficy Plant Applications Client.
	Syntax	Sub RaiseTrendFromDialog(StartTime, EndTime, VarId As Long, VarTag As String, AlarmTypeId As Long)

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.

In the registry for the current user.
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