Web Message Box (PRIM_WEB.MessageBox)

Web Message box

Ancestors - Object (PRIM_OBJT)

Details

The Web Message Box is a formatted message box allowing Captions and an Image to be a shown.
 
Despite appearing to be modal, the runtime will continue once the message box has been shown. It is therefore necessary to store the Result as a property.
 
Message Box should be defined at the top of the code.

Example

In this example, the message box presents a Yes or No option.
 
The button is updated with the result.
Begin_Com Role(*EXTENDS #PRIM_WEB)
 
   Define_Com Class(#prim_web.messageBox) Name(#MessageBox) Caption('Continue?') Buttons(YesNo) Image(Question)
 
   Define_Com Class(#PRIM_PHBN) Name(#Button) Caption('Continue?') Displayposition(1) Left(154) Parent(#COM_OWNER) Tabposition(1) Top(53)
 
   Evtroutine Handling(#Button.Click)
 
      #MessageBox.Show
 
   Endroutine
 
   Evtroutine Handling(#MessageBox.Closed)
 
      #Button.Caption := #MessageBox.Result
 
   Endroutine
 
End_Com

Properties

NameDescription
ButtonsButtons to show on the message box
ButtonStyleStyle to be applied to the message box buttons
ButtonStylesCollection of styles to apply to the message box buttons
CaptionCaption to be shown
CaptionsCollection of captions to be shown
CaptionStyleStyle to be applied to the message box captions
CaptionStylesCollection of styles to apply to the captions
ComponentClassNameComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembersComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternNameComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTagGeneric space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentTypeComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeNameComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
CustomImageUser defined image to display
ImageChoice of images e.g. Error, Exclamation etc.
NameName identifies the component Inherited from Object (PRIM_OBJT)
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
ParentThe component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances Inherited from Object (PRIM_OBJT)
ResultResult containing the name of the button pressed
TitleTitle of message box

Events

NameDescription
ClosedFired when the message box is closed
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from Web Message Box (PRIM_WEB.MessageBox)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Web Message Box (PRIM_WEB.MessageBox)

Methods

NameDescription
ShowShow the message box

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020