Messaging Class
The Messaging class is a non-visual custom class that contains methods called by code throughout the application where messages are displayed. In a VPM Enterprise application the Messaging object is instantiated from this class and thereafter its properties and methods can be referenced or called using the _SCREEN.oApp.oMessage object reference.
Properties
The following table lists the class properties. The properties listed include the standard Visual FoxPro class properties that the VPM Enterprise class uses and the VPM Enterprise custom properties. Where appropriate, the Comments column of the table describes a property and provides suggestions for its use.
|
Property & Initial Value |
Comments |
|
Standard Properties Used: |
|
|
Name = “messaging” |
|
|
Custom Properties: |
|
|
cAlternateFormCaption = “” |
Used to store the alternate form caption passed to the DisplayMessage method via the stcAltFormCaption parameter. |
|
cAlternateMessage = “” |
Used to store the alternate message text passed to the DisplayMessage method via the stcAltMessage parameter. |
|
cExclamation = “mess_ep.bmp” |
Contains the name of the bitmap to be used when an exclamation point picture is displayed on the message form. |
|
cInformation = “mess_i.bmp” |
Contains the name of the bitmap to be used when an information picture is displayed on the message form. |
|
cMessageAddition = “” |
Used to store the additional message text passed to the DisplayMessage method via the stcMessageAddition parameter. |
|
cQuestion = “mess_qm.bmp” |
Contains the name of the bitmap to be used when a question mark picture is displayed on the message form. |
|
cStop = “mess_ss.bmp” |
Contains the name of the bitmap to be used when a stop sign picture is displayed on the message form. |
|
nMessageReturnValue = 0 |
Set by the message form to specify the value to be returned by the DisplayForm method and in turn the DisplayMessage method. |
Methods
The following table lists the class methods. The methods listed include the standard Visual FoxPro class methods that the VPM Enterprise class uses and the VPM Enterprise custom methods. Where appropriate, the Comments column of the table describes a method and provides suggestions for its use.
|
Method |
Comments |
|
Standard Methods Used: |
None |
|
Custom Methods: |
|
|
ClearStatusBarMessage |
Clears the status bar. |
|
ClearWait |
Removes the current WAIT WINDOW. |
|
DisplayForm |
Displays a message form, which gets the message definition from the current record in the Message view cursor. |
|
DisplayMessage |
Called to display a message that has been defined in the Messages table. It finds the record in the Messages view (SVPM_V!Messages_V) that is identified by the parameter stcMessageID. It then calls the method that displays the type of message defined in the Messages table record. Parameters: stcMessageID, stcAltMessage, stcMessageAddition, stcAltFormCaption |
|
DisplayStatusBarMessage |
Displays a message in the status bar. |
|
DisplayWait |
Displays a message in a WAIT WINDOW. |
|
SoundBell |
Sounds the bell. |
