Alert (PRIM_MD.Alert)

Popup message box that closes automatically

Ancestors - Panel (PRIM_PANL)Container (PRIM_CPST)Control (PRIM_CTRL)Object (PRIM_OBJT)

Details

An Alert is a simple popup message box that closes automatically after a short delay.
 
The delay before closing is controlled by the Duration parameter of the ShowAlert method.

Example

In this example, two buttons are used to display the alerts.
 
Both are attached to the bottom of the screen, flowing up so that they don't overlay each other.
Begin_Com Role(*EXTENDS #PRIM_WEB) Theme(#SYS_THEME) Height(481) Width(705) LayoutManager(#Layout1)
 
   Define_Com Class(#PRIM_TBLO) Name(#Layout1)
   Define_Com Class(#PRIM_TBLO.Row) Name(#Layout1Row1) DisplayPosition(1) Parent(#Layout1)
   Define_Com Class(#PRIM_TBLO.Column) Name(#Layout1Column1) DisplayPosition(1) Parent(#Layout1)
   Define_Com Class(#PRIM_TBLO.Item) Name(#Layout1Item1) Alignment(BottomCenter) Column(#Layout1Column1) Manage(#Success) Parent(#Layout1) Row(#Layout1Row1) Sizing(None) Flow(Up)
   Define_Com Class(#PRIM_TBLO.Item) Name(#Layout1Item2) Alignment(BottomCenter) Column(#Layout1Column1) Manage(#Error) Parent(#Layout1) Row(#Layout1Row1) Sizing(None) Flow(Up)
 
   Define_Com Class(#PRIM_MD.Alert) Name(#Success) Caption('Success! This Alert could indicate a successful or positive action') DisplayPosition(1) Left(77) Parent(#COM_OWNER) TabPosition(1) TabStop(False) ThemeDrawStyle('LightSuccess') Top(425) Visible(False)
 
   Define_Com Class(#PRIM_MD.Alert) Name(#Error) Caption('Error! This Alert box could indicate a negative or potentially dangerous action') DisplayPosition(2) TabPosition(2) TabStop(False) ThemeDrawStyle('LightError') Top(369) Parent(#COM_OWNER) Left(77) Visible(False)
 
   Define_Com Class(#PRIM_MD.RaisedButton) Name(#ShowSuccess) Caption('Show Success Alert') DisplayPosition(4) Left(8) Parent(#COM_OWNER) TabPosition(4) ThemeDrawStyle('MediumSuccess') Top(21) Width(177)
   Define_Com Class(#PRIM_MD.RaisedButton) Name(#ShowError) Caption('Show Error Alert') DisplayPosition(3) Left(8) Parent(#COM_OWNER) TabPosition(3) ThemeDrawStyle('MediumError') Top(64) Width(177)
 
   Evtroutine Handling(#ShowSuccess.Click)
 
      #Success.ShowAlert
 
   Endroutine
 
   Evtroutine Handling(#ShowError.Click)
 
      #Error.ShowAlert
 
   Endroutine
 
End_Com

Properties

Name Description
BusyUpdates BusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL)
BusyUpdatesOfParent BusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL)
CanFocus CanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL)
Caption Text to be displayed within the popup
CaptionAlignment Position of the caption within the control
CaptionMarginBottom Bottom margin in pixels
CaptionMarginLeft Left margin in pixels
CaptionMarginRight Right margin in pixels
CaptionMarginTop Top margin in pixels
CloseIcon Show or hide the close icon
ComponentClassName ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentControls ComponentControls is a collection of all the controls contained in this component. Inherited from Container (PRIM_CPST)
ComponentMembers ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternName ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTag Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentType ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeName ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
Cursor Cursor sets the cursor image Inherited from Control (PRIM_CTRL)
DesignManager Reference to a Design Manager instance for this panel Inherited from Panel (PRIM_PANL)
DisableNoScroll DisableNoScroll controls whether scroll bars are displayed. Inherited from Panel (PRIM_PANL)
DisplayPosition DisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL)
DragStyle DragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL)
Duration Duration the alert will be displayed for in milliseconds
Ellipses Show ellipses for truncated text
EnableChildren EnableChildren specifies if the parent sets the Enabled property of child components Inherited from Container (PRIM_CPST)
Enabled Enable activates/deactivates the component Inherited from Control (PRIM_CTRL)
FixedPosition Fix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL)
Focus Focus tells whether the component has focus Inherited from Control (PRIM_CTRL)
FocusedStyle Reference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusedStyles Collection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL)
Handle Returns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL)
Height The height of the control in pixels Inherited from Control (PRIM_CTRL)
Hint Caption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL)
HintPopup HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL)
HintShow Enabled or disable the appearance of hints Inherited from Control (PRIM_CTRL)
HintShowOfParent Delegate hints appearance to the parent control Inherited from Control (PRIM_CTRL)
HintTitle HintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL)
HorizontalScroll Show the horizontal scroll bar Inherited from Panel (PRIM_PANL)
HorizontalScrollInc HorizontalScrollInc specifies the pixel increment for horizontal scroll bar. Inherited from Panel (PRIM_PANL)
HorizontalScrollPos HorizontalScrollPos sets the position of the horizontal scroll bar Inherited from Panel (PRIM_PANL)
HorizontalScrollRemainder Specifies the pixels remaining to the right of the current scroll position Inherited from Panel (PRIM_PANL)
Icon Image displayed within the alert
IconAlignment Position of the icon within the control
IconColor Color to be applied to the icon
IconFileName FileName is the name of image file
IconHeight Height of the icon in pixels
IconImage Material design image to show on the control
IconImageSizing Specifies the sizing behaviour of the IconImage
IconMarginBottom Bottom margin in pixels
IconMarginLeft Left margin in pixels
IconMarginRight Right margin in pixels
IconMarginTop Top margin in pixels
IconOpacity Percentage opacity of the icon
IconPadding Padding of the icon in pixels
IconThemeDrawStyle Name of the Theme DrawStyle to be applied to the icon
Image Repository enrolled image to show in the control Inherited from Panel (PRIM_PANL)
ImageAlignment Position of the image within the panel Inherited from Panel (PRIM_PANL)
IsAnimating IsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL)
IsRealized True if the control is currently realized Inherited from Control (PRIM_CTRL)
LayoutManager Reference to a layout manager used to control the position of child controls Inherited from Panel (PRIM_PANL)
Left Position of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL)
Modified Modified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL)
MouseOver MouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL)
MouseOverPart True if the cursor is within the bounds of a child component Inherited from Container (PRIM_CPST)
MouseOverStyle MouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
MouseOverStyles MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
Name Name identifies the component Inherited from Object (PRIM_OBJT)
Opacity Opacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL)
Owner Owner owns this component Inherited from Object (PRIM_OBJT)
PaddingBottom Bottom padding in pixels
PaddingLeft Left padding in pixels
PaddingRight Right padding in pixels
PaddingTop Top padding in pixels
Parent Reference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL)
Popup Popup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL)
PopupMenu Reference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL)
PrivateStyle Style applied to the control but not inherited by child controls Inherited from Container (PRIM_CPST)
PrivateStyles Collection of styles applied to the control but not inherited by child controls Inherited from Container (PRIM_CPST)
RenderStyle Render content as DirectX or defer to the parent control Inherited from Panel (PRIM_PANL)
Rotation Rotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL)
RotationOriginLeft RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RotationOriginTop RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
ScaleHeight ScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScaleOriginLeft ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleOriginTop ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleWidth ScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScreenLeft ScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL)
ScreenTop ScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL)
ScrollLeft Left position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
ScrollTop Top position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
SkewLeft SkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL)
SkewOriginLeft SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewOriginTop SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewTop SkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL)
Style Style defines the style to be applied to a control Inherited from Control (PRIM_CTRL)
Styles Collection of styles to be applied to the control Inherited from Control (PRIM_CTRL)
TabPosition TabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL)
TabStop Set to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL)
ThemeBackground Background theme to be used
ThemeDrawStyle Name of the Theme DrawStyle to be applied to the panel Inherited from Panel (PRIM_PANL)
ThemeStyle Specifies how theme usage is determined Inherited from Panel (PRIM_PANL)
Top Position of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL)
TouchMove Determines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL)
TouchRotate Determines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL)
TouchScale Determines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL)
TouchSize Determines whether a control can be resized Inherited from Control (PRIM_CTRL)
VerticalScroll Show the vertical scroll bar Inherited from Panel (PRIM_PANL)
VerticalScrollInc VerticalScrollInc specifies the pixel increment for vertical scroll bar. Inherited from Panel (PRIM_PANL)
VerticalScrollPos VerticalScrollPos sets the position of the vertical scroll bar Inherited from Panel (PRIM_PANL)
VerticalScrollRemainder Specifies the pixels left to the botom from the current scroll position Inherited from Panel (PRIM_PANL)
Visible Show or hide the control Inherited from Control (PRIM_CTRL)
VisualStyle VisualStyle sets the appearance Inherited from Control (PRIM_CTRL)
VisualStyleOfParent Adopt the Visual style from the parent control Inherited from Control (PRIM_CTRL)
Width Width of the component in pixels Inherited from Control (PRIM_CTRL)
WordWrap Wrap text on to the next line if there is insufficient space

Events

Name Description
AnimationEnded Fired when an animation is ended Inherited from Alert (PRIM_MD.Alert)
Cancelled
Click Fired when the mouse is clicked on the control Inherited from Alert (PRIM_MD.Alert)
Origin, Handled
CloseIconClick Fired when the close icon is clicked
Origin, Handled
CreateInstance CreateInstance is signalled when an instance of a component is created Inherited from Alert (PRIM_MD.Alert)
DesignChanged Fired when the a design is activated Inherited from Alert (PRIM_MD.Alert)
Design, DesignManager
DestroyInstance DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Alert (PRIM_MD.Alert)
DoubleClick Fired when the user double clicks Inherited from Alert (PRIM_MD.Alert)
Origin, Handled
DragDrop Fired on mouse up to signify the end of a drag process Inherited from Alert (PRIM_MD.Alert)
PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult
DragOver Fired during the drag and drop process when the cursor moves over the control Inherited from Alert (PRIM_MD.Alert)
PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled
EndDrag Fired when the drag and drop process has completed Inherited from Alert (PRIM_MD.Alert)
Source, Payload, DragResult, AggregatedSource, Origin, Handled
Enter Fired when the Enter key is pressed Inherited from Alert (PRIM_MD.Alert)
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
Initialize Fired after a component has been realized for the first time Inherited from Alert (PRIM_MD.Alert)
KeyPress Fired when a key is pressed on the keyboard Inherited from Alert (PRIM_MD.Alert)
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
MouseEnter The mouse has entered the bounds of the control Inherited from Alert (PRIM_MD.Alert)
MouseHover The mouse has hovered over the control Inherited from Alert (PRIM_MD.Alert)
Origin, Handled
MouseLeave The mouse has left the bounds of the control Inherited from Alert (PRIM_MD.Alert)
ScrollChanged Fired when the scrollbars in a composite control are moved Inherited from Alert (PRIM_MD.Alert)
Orientation
SizeChanged Fired when the size of the panel is changed Inherited from Alert (PRIM_MD.Alert)
StartDrag Fired when the user starts a drag and drop process Inherited from Alert (PRIM_MD.Alert)
Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled
TouchChange Fired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events Inherited from Alert (PRIM_MD.Alert)
MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue
TouchEnd Fired when the user stops touching the screen Inherited from Alert (PRIM_MD.Alert)
TouchStart Fired when the user first makes physical contact with the screen Inherited from Alert (PRIM_MD.Alert)
Origin, TouchMove, TouchRotate, TouchScale, TouchSize

Methods

Name Description
FadeIn Animate from invisible to visible Inherited from Control (PRIM_CTRL)
Duration, Delay
FadeOut Animate from visible to invisible Inherited from Control (PRIM_CTRL)
Duration, Delay, Visible
HideAlert Hide the alert
HorizontalScrollTo Set the horizontal scroll position using a child control Inherited from Panel (PRIM_PANL)
Control, ScrollPosition
MoveFrom Move a control from the specified position to the current position Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
MoveTo Animate a move from the specified number of pixels Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
Realize Creates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
Scale Animate a change of scale Inherited from Control (PRIM_CTRL)
ScaleWidth, ScaleHeight, Duration, Delay
SetFocus Sets the control to be the focus control Inherited from Control (PRIM_CTRL)
ShowAlert Show the alert popup
ShowMessages LANSA Internal Use Inherited from Control (PRIM_CTRL)
SizeTo Changes and animates control size changing Inherited from Control (PRIM_CTRL)
Width, Height, Duration, Delay
Transition Animate the change from one control to another Inherited from Container (PRIM_CPST)
From, To, TransitionType, Duration, Delay
Unrealize Destroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
UpdateDisplay UpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL)
VerticalScrollTo Set the vertical scroll position using a child control Inherited from Panel (PRIM_PANL)
Control, ScrollPosition

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020