Properties: Proficy_ALM.AlarmView Control
|
Purpose |
Returns a string that tells what a specified command has done. |
|
|
Read-only |
|
Syntax |
Property CommandDescription(CommandName) As String |
|
Purpose |
Set any of the following display options. |
|
|
|
Read/Write |
|
|
Syntax |
Property DisplayOption(OptionName As String, [DontDraw As Boolean]) |
|
|
|
Where [DontDraw As True] = Do not refresh the screen until all of the options that should be set are set. [DontDraw As False] = Refresh the screen after each option is set. |
|
|
|
Display Option |
Description |
|
|
AckByVisible |
Display an acknowledged value of Yes/No. |
|
|
ActionCommentVisible |
Display/do not display the Action Column Indicator icon. |
|
|
ActionVisible |
Display/do not display the Action Reason value. |
|
|
AckVisible |
Display/do not display the name of the user who acknowledged the alarm. |
|
|
AlarmTimeOut |
Create an audible alarm for one minute after a specified time out value (minutes) is reached. |
|
|
AudibleAlarm |
Sound a tone for each alarm if the sound binary ID's are set. |
|
|
CauseCommentVisible |
Display/do not display the Comment Indicator icon. |
|
|
CauseVisible |
Display/do not display the Cause Reason value. |
|
|
CommentSplitterRatio |
Set the Comment window size as a percentage of the Display window. |
|
|
CommentSubText |
Select a comment type that will be previewed in an alarm's Row 2. Types are:
|
|
|
CommentWindow |
Open the Comment window. |
|
|
DescriptionVisible |
Display the Description Value-variable template, trigger, and/or custom text descriptions as defined by the template. |
|
|
DisplayHyperLinks |
Show/hide the Hyperlink menu at startup. |
|
|
DurationVisible |
Display/do not display the length of time (duration) that the value was in alarm state. |
|
|
EndVisible |
Show/hide the alarm End Time. |
|
|
HighMsgBox |
Display/do not display a Message box for each high priority alarm. |
|
|
HighPrioritySoundBinaryId |
Set the high priority sound tone. |
|
|
HyperlinkSplitterWidth |
Display/do not display the Hyperlink menu to the right of the contro (pixels). |
|
|
IncludeAck |
Display/do not display acknowledged alarms. |
|
|
IncludeHighPriority |
Display/do not display high priority alarms. |
|
|
IncludeLowPriority |
Display/do not display low priority alarms. |
|
|
IncludeMediumPriority |
Display/do not display medium priority alarms. |
|
|
IncludeUnAck |
Display/do not display unacknowledged alarms. |
|
|
LowMsgBox |
Display/do not display a Message box for each low priority alarm. |
|
|
LowPrioritySoundBinaryId |
Set the low priority sound tone. |
|
|
MediumMsgBox |
Display/do not display a Message box for each medium priority alarm. |
|
|
MediumPrioritySoundBinaryId |
Set the medium priority sound tone. |
|
|
MsgBoxBackColor1Id |
Select the Message Box background color number 1. Choices are:
|
|
|
MsgBoxBackColor2Id |
Select the Message Box background color number 2. Choices are the same as for MsgBoxBackColor1Id. |
|
|
OnlyOpenAlarms |
Display only alarms that are open. |
|
|
OpenColorId |
Color for an open alarm. |
|
|
PopUpTrendAlarmPriority |
Automatically opens an ad-hoc Trend for SPC alarms greater than or equal to a selected priority value. |
|
|
PriorityVisible |
Display the alarm priority value. |
|
|
QuickSearchRowCount |
(When using Quick Search) limit the number of alarms of the same variable that are retrieved. |
|
|
RequiredReasonsColorId |
Set the color for alarms that are required to have cause and action reasons selected. |
|
|
SortingOrder |
Select the field to sort alarms by. Choices are:
|
|
|
StartVisible |
Display/do not display the alarm start time. |
|
|
ValueVisible |
Display/do not display the alarm start value. |
|
|
VarTempCommentVisible |
Display/do not display the Variable Template comment value. |
|
Purpose |
Returns a description of each display option by name. |
|
|
Read-only |
|
Syntax |
Property DisplayOptionDescription(CommandName) As String |
|
Purpose |
Returns the end time of the current row. |
|
|
Read-only |
|
Syntax |
Property EndTime (As Date) |
|
Purpose |
Show/hide the Hyperlink menu to the right of the control. |
|
|
Value |
Show |
True |
|
|
Hide |
False |
|
|
Read/Write |
|
|
Syntax |
Property HyperLinkMenuVisible As Boolean |
|
Purpose |
Displays an Error message that describes the last error. |
|
|
Read-only |
|
Syntax |
Property LastError As String |
|
Purpose |
Internal use only. |
|
|
Read-only |
|
Syntax |
Property PopUpTrendAlarmPriority As Long |
|
Purpose |
Set the name of the display that the control will display. |
|
|
Read/Write |
|
Syntax |
Property SheetName As String |
|
Purpose |
Show when the control started for the current session. |
|
|
Read/Write |
|
Syntax |
Property StartTime As Date |
|
Purpose |
Show/hide the Status Bar. |
|
|
Value |
Show |
True |
|
|
Hide |
False |
|
|
Read/Write |
|
|
Syntax |
Property StatusBarVisible As Boolean |