ShowBitmap()
Summary
Displays a Windows bitmap file in a window.
Syntax
action = ShowBitmap(string filename, array options)
| Argument | Contents |
|---|---|
| filename | The complete path and file name of a Windows bitmap file |
| Option | Type | Contents |
|---|---|---|
| UserClick | Boolean | If "True" the window closes as soon as a user clicks on it. If "False" a click has no effect |
| CloseAfter | Integer | Number of seconds after which the window closes automatically |
| StartupClose | Boolean | If "True" the bitmap is used as an application title screen. See below |
| Borders | Boolean | If "True" ShowBitmap() displays the bitmap with borders and a title bar |
| Title | String | The title of the bitmap window (Borders must be "True") |
| Wait | Boolean | Whether ShowBitmap() waits until the window closes or returns immediately |
| Position | Integer, integer | The horizontal and vertical positions of the window, as a percentage of the program window (if Borders is "True") or of the desktop (if Borders is "False") |
Returns
A string that indicates the key pressed by the user to close the window.
| Return value | Returned when |
|---|---|
| null | The Wait option is "False" |
| Home | The user presses the Home key |
| End | The user presses the End key |
| Escape | The user presses the Esc key |
| Help | The user presses the F1 key |
| Previous | The user presses the left or up arrow keys |
| Next | The user presses the right or down arrow keys, or closes the window by clicking on it with the mouse |
Notes
-
ShowBitmap() can be used to create slideshows.
-
The UserClick option defaults to "True".
-
The Wait option defaults to "False" unless the UserClick option is "True" and no other options are specified.
-
The Wait option should not be specified with the StartupClose option.
-
The StartupClose option can be used to create a title screen display for a custom application. While the bitmap is displayed, other macro initialization continues. When initialization is complete, the bitmap window is closed automatically.
Example
ShowBitmap("mytitle.bmp", {{"CloseAfter", 10}})
Error Codes
| Error Type | Meaning |
|---|---|
| NotFound | The bitmap window cannot be opened |
See Also
| Function | Summary |
|---|---|
| ShowMessage() | Shows a message in a standard Windows message box |