Annunciator Class
Click or drag to resize

Annunciator Class

Wikipedia: An annunciator panel is a group of lights used as a central indicator of status of equipment or systems in an aircraft, industrial process, building or other installation. Usually the annunciator panel includes a main warning lamp or audible signal to draw the attention of operating personnel to the annunciator panel for abnormal events or conditions.

The Anunciator control provides a simple, standard method of displaying a status notification to the user within a Windows Forms application. Anunciators are best used with the companion AnnunciatorPanel control, although they can be placed anywhere on a Windows Form. The control can be used to provide simple On/Off status displays or can be configured to blink with various levels of urgency so that it can represent alarm conditions.

Examples
An anunciator may represent the slewing state of a telescope. It would be represented by the word "SLEW". When the telescope is stationary, the anunciator remains inactive. When the telescope begins to slew, the anunciator is set to BlinkFast to alert the user that the equipment is in motion.

Each anunciator has active and inactive states. When inactive, the control displays in a subdued colour that is readable but does not draw attention. When active, the control will display in a stronger, more visible colour and will either have a steady state or will blink in one of a number of predefined cadence patterns. The cadence patterns are fixed and not user-definable, so that a standard 'look and feel' is promoted accross different applications.

Whilst the user is at liberty to choose different colours for both ActiveColor and InactiveColor, The default colours have been chosen to look similar to earlier applications that use similar displays and the defaults are highly recommended for most circumstances. The control's background colour is inherited from the parent control (which should normally be an AnnunciatorPanel) and is not directly settable by the user.

Inheritance Hierarchy
SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsLabel
          ASCOM.ControlsAnnunciator

Namespace:  ASCOM.Controls
Assembly:  ASCOM.Controls (in ASCOM.Controls.dll) Version: 6.0.0.0 (6.4.0.2624)
Syntax
public sealed class Annunciator : Label

The Annunciator type exposes the following members.

Constructors
  NameDescription
Public methodAnnunciator
Initializes a new instance of the Annunciator class.
Top
Properties
  NameDescription
Public propertyAccessibilityObject (Inherited from Control.)
Public propertyAccessibleDefaultActionDescription (Inherited from Control.)
Public propertyAccessibleDescription (Inherited from Control.)
Public propertyAccessibleName (Inherited from Control.)
Public propertyAccessibleRole (Inherited from Control.)
Public propertyActiveColor
Gets or sets the color of the anunciator text when active.
Public propertyAllowDrop (Inherited from Control.)
Public propertyAnchor (Inherited from Control.)
Public propertyAutoEllipsis (Inherited from Label.)
Public propertyAutoScrollOffset (Inherited from Control.)
Public propertyAutoSize (Inherited from Label.)
Public propertyBackColor
Gets or sets the background color for the control.
(Overrides ControlBackColor.)
Public propertyBackgroundImage (Inherited from Label.)
Public propertyBackgroundImageLayout (Inherited from Label.)
Public propertyBindingContext (Inherited from Control.)
Public propertyBorderStyle (Inherited from Label.)
Public propertyBottom (Inherited from Control.)
Public propertyBounds (Inherited from Control.)
Public propertyCadence
Gets or sets the cadence (blink pattern) of the anunciator. Different cadence patterns imply different levels of urgency or severity.
Public propertyCanFocus (Inherited from Control.)
Public propertyCanSelect (Inherited from Control.)
Public propertyCapture (Inherited from Control.)
Public propertyCausesValidation (Inherited from Control.)
Public propertyClientRectangle (Inherited from Control.)
Public propertyClientSize (Inherited from Control.)
Public propertyCompanyName (Inherited from Control.)
Public propertyContainer (Inherited from Component.)
Public propertyContainsFocus (Inherited from Control.)
Public propertyContextMenu (Inherited from Control.)
Public propertyContextMenuStrip (Inherited from Control.)
Public propertyControls (Inherited from Control.)
Public propertyCreated (Inherited from Control.)
Public propertyCursor (Inherited from Control.)
Public propertyDataBindings (Inherited from Control.)
Public propertyDisplayRectangle (Inherited from Control.)
Public propertyDisposing (Inherited from Control.)
Public propertyDock (Inherited from Control.)
Public propertyEnabled (Inherited from Control.)
Public propertyFlatStyle (Inherited from Label.)
Public propertyFocused (Inherited from Control.)
Public propertyFont (Inherited from Control.)
Public propertyForeColor
Gets or sets the foreground color of the control. There is little point in setting this value directly as it will normally be constantly overwritten at runtime.
(Overrides ControlForeColor.)
Public propertyHandle (Inherited from Control.)
Public propertyHasChildren (Inherited from Control.)
Public propertyHeight (Inherited from Control.)
Public propertyImage (Inherited from Label.)
Public propertyImageAlign (Inherited from Label.)
Public propertyImageIndex (Inherited from Label.)
Public propertyImageKey (Inherited from Label.)
Public propertyImageList (Inherited from Label.)
Public propertyImeMode (Inherited from Label.)
Public propertyInactiveColor
Gets or sets the color of the anunciator text when inactive.
Public propertyInvokeRequired (Inherited from Control.)
Public propertyIsAccessible (Inherited from Control.)
Public propertyIsDisposed (Inherited from Control.)
Public propertyIsHandleCreated (Inherited from Control.)
Public propertyIsMirrored (Inherited from Control.)
Public propertyLayoutEngine (Inherited from Control.)
Public propertyLeft (Inherited from Control.)
Public propertyLocation (Inherited from Control.)
Public propertyMargin (Inherited from Control.)
Public propertyMaximumSize (Inherited from Control.)
Public propertyMinimumSize (Inherited from Control.)
Public propertyMute
Gets or sets a value indicating whether the control can respond to user interaction. For an anunciator, this affects how it displays. A disabled anunciator will always display in its InactiveColor regardless of other settings and it will not participate in cadence updates.
Public propertyName (Inherited from Control.)
Public propertyPadding (Inherited from Control.)
Public propertyParent (Inherited from Control.)
Public propertyPreferredHeight (Inherited from Label.)
Public propertyPreferredSize (Inherited from Control.)
Public propertyPreferredWidth (Inherited from Label.)
Public propertyProductName (Inherited from Control.)
Public propertyProductVersion (Inherited from Control.)
Public propertyRecreatingHandle (Inherited from Control.)
Public propertyRegion (Inherited from Control.)
Public propertyRight (Inherited from Control.)
Public propertyRightToLeft (Inherited from Control.)
Public propertySite (Inherited from Control.)
Public propertySize (Inherited from Control.)
Public propertyTabIndex (Inherited from Control.)
Public propertyTabStop (Inherited from Label.)
Public propertyTag (Inherited from Control.)
Public propertyText (Inherited from Label.)
Public propertyTextAlign (Inherited from Label.)
Public propertyTop (Inherited from Control.)
Public propertyTopLevelControl (Inherited from Control.)
Public propertyUseCompatibleTextRendering (Inherited from Label.)
Public propertyUseMnemonic (Inherited from Label.)
Public propertyUseWaitCursor (Inherited from Control.)
Public propertyVisible (Inherited from Control.)
Public propertyWidth (Inherited from Control.)
Public propertyWindowTarget (Inherited from Control.)
Top
Methods
  NameDescription
Public methodBeginInvoke(Delegate) (Inherited from Control.)
Public methodBeginInvoke(Delegate, Object) (Inherited from Control.)
Public methodBringToFront (Inherited from Control.)
Public methodCadenceUpdate
Updates the anunciator's display, if it has changed since the last update.
Public methodContains (Inherited from Control.)
Public methodCreateControl (Inherited from Control.)
Public methodCreateGraphics (Inherited from Control.)
Public methodCreateObjRef (Inherited from MarshalByRefObject.)
Public methodDispose
Releases all resources used by the Component.
Public methodDoDragDrop (Inherited from Control.)
Public methodDrawToBitmap (Inherited from Control.)
Public methodEndInvoke (Inherited from Control.)
Public methodFindForm (Inherited from Control.)
Public methodFocus (Inherited from Control.)
Public methodGetChildAtPoint(Point) (Inherited from Control.)
Public methodGetChildAtPoint(Point, GetChildAtPointSkip) (Inherited from Control.)
Public methodGetContainerControl (Inherited from Control.)
Public methodGetLifetimeService (Inherited from MarshalByRefObject.)
Public methodGetNextControl (Inherited from Control.)
Public methodGetPreferredSize (Inherited from Label.)
Public methodHide (Inherited from Control.)
Public methodInitializeLifetimeService (Inherited from MarshalByRefObject.)
Public methodInvalidate (Inherited from Control.)
Public methodInvalidate(Region) (Inherited from Control.)
Public methodInvalidate(Boolean) (Inherited from Control.)
Public methodInvalidate(Rectangle) (Inherited from Control.)
Public methodInvalidate(Region, Boolean) (Inherited from Control.)
Public methodInvalidate(Rectangle, Boolean) (Inherited from Control.)
Public methodInvoke(Delegate) (Inherited from Control.)
Public methodInvoke(Delegate, Object) (Inherited from Control.)
Public methodPerformLayout (Inherited from Control.)
Public methodPerformLayout(Control, String) (Inherited from Control.)
Public methodPointToClient (Inherited from Control.)
Public methodPointToScreen (Inherited from Control.)
Public methodPreProcessControlMessage (Inherited from Control.)
Public methodPreProcessMessage (Inherited from Control.)
Public methodRectangleToClient (Inherited from Control.)
Public methodRectangleToScreen (Inherited from Control.)
Public methodRefresh (Inherited from Control.)
Public methodResetBackColor (Inherited from Control.)
Public methodResetBindings (Inherited from Control.)
Public methodResetCursor (Inherited from Control.)
Public methodResetFont (Inherited from Control.)
Public methodResetForeColor (Inherited from Control.)
Public methodResetImeMode (Inherited from Control.)
Public methodResetRightToLeft (Inherited from Control.)
Public methodResetText (Inherited from Control.)
Public methodResumeLayout (Inherited from Control.)
Public methodResumeLayout(Boolean) (Inherited from Control.)
Public methodScale(Single) Obsolete. (Inherited from Control.)
Public methodScale(SizeF) (Inherited from Control.)
Public methodScale(Single, Single) Obsolete. (Inherited from Control.)
Public methodSelect (Inherited from Control.)
Public methodSelectNextControl (Inherited from Control.)
Public methodSendToBack (Inherited from Control.)
Public methodSetBounds(Int32, Int32, Int32, Int32) (Inherited from Control.)
Public methodSetBounds(Int32, Int32, Int32, Int32, BoundsSpecified) (Inherited from Control.)
Public methodShow (Inherited from Control.)
Public methodSuspendLayout (Inherited from Control.)
Public methodToString (Inherited from Label.)
Public methodUpdate (Inherited from Control.)
Top
Events
  NameDescription
Public eventAutoSizeChanged (Inherited from Label.)
Public eventBackColorChanged (Inherited from Control.)
Public eventBackgroundImageChanged (Inherited from Label.)
Public eventBackgroundImageLayoutChanged (Inherited from Label.)
Public eventBindingContextChanged (Inherited from Control.)
Public eventCausesValidationChanged (Inherited from Control.)
Public eventChangeUICues (Inherited from Control.)
Public eventClick (Inherited from Control.)
Public eventClientSizeChanged (Inherited from Control.)
Public eventContextMenuChanged (Inherited from Control.)
Public eventContextMenuStripChanged (Inherited from Control.)
Public eventControlAdded (Inherited from Control.)
Public eventControlRemoved (Inherited from Control.)
Public eventCursorChanged (Inherited from Control.)
Public eventDisposed (Inherited from Component.)
Public eventDockChanged (Inherited from Control.)
Public eventDoubleClick (Inherited from Control.)
Public eventDragDrop (Inherited from Control.)
Public eventDragEnter (Inherited from Control.)
Public eventDragLeave (Inherited from Control.)
Public eventDragOver (Inherited from Control.)
Public eventEnabledChanged (Inherited from Control.)
Public eventEnter (Inherited from Control.)
Public eventFontChanged (Inherited from Control.)
Public eventForeColorChanged (Inherited from Control.)
Public eventGiveFeedback (Inherited from Control.)
Public eventGotFocus (Inherited from Control.)
Public eventHandleCreated (Inherited from Control.)
Public eventHandleDestroyed (Inherited from Control.)
Public eventHelpRequested (Inherited from Control.)
Public eventImeModeChanged (Inherited from Label.)
Public eventInvalidated (Inherited from Control.)
Public eventKeyDown (Inherited from Label.)
Public eventKeyPress (Inherited from Label.)
Public eventKeyUp (Inherited from Label.)
Public eventLayout (Inherited from Control.)
Public eventLeave (Inherited from Control.)
Public eventLocationChanged (Inherited from Control.)
Public eventLostFocus (Inherited from Control.)
Public eventMarginChanged (Inherited from Control.)
Public eventMouseCaptureChanged (Inherited from Control.)
Public eventMouseClick (Inherited from Control.)
Public eventMouseDoubleClick (Inherited from Control.)
Public eventMouseDown (Inherited from Control.)
Public eventMouseEnter (Inherited from Control.)
Public eventMouseHover (Inherited from Control.)
Public eventMouseLeave (Inherited from Control.)
Public eventMouseMove (Inherited from Control.)
Public eventMouseUp (Inherited from Control.)
Public eventMouseWheel (Inherited from Control.)
Public eventMove (Inherited from Control.)
Public eventPaddingChanged (Inherited from Control.)
Public eventPaint (Inherited from Control.)
Public eventParentChanged (Inherited from Control.)
Public eventPreviewKeyDown (Inherited from Control.)
Public eventQueryAccessibilityHelp (Inherited from Control.)
Public eventQueryContinueDrag (Inherited from Control.)
Public eventRegionChanged (Inherited from Control.)
Public eventResize (Inherited from Control.)
Public eventRightToLeftChanged (Inherited from Control.)
Public eventSizeChanged (Inherited from Control.)
Public eventStyleChanged (Inherited from Control.)
Public eventSystemColorsChanged (Inherited from Control.)
Public eventTabIndexChanged (Inherited from Control.)
Public eventTabStopChanged (Inherited from Label.)
Public eventTextAlignChanged (Inherited from Label.)
Public eventTextChanged (Inherited from Control.)
Public eventValidated (Inherited from Control.)
Public eventValidating (Inherited from Control.)
Public eventVisibleChanged (Inherited from Control.)
Top
See Also