SplashTextOn / SplashTextOff

Creates or removes a customizable text popup window.

Deprecated: These commands are not recommended for use in new scripts. Use the Gui command instead.

SplashTextOn , Width, Height, Title, Text
SplashTextOff

Parameters

Width

If blank or omitted, it defaults to 200. Otherwise, specify the width in pixels of the window. This parameter can be an expression.

Height

If blank or omitted, it defaults to 0 (i.e. just the title bar will be shown). Otherwise, specify the height in pixels of the window (not including its title bar). This parameter can be an expression.

Title

If blank or omitted, it defaults to an empty title. Otherwise, specify the title of the window.

Text

If blank or omitted, it defaults to an empty text. Otherwise, specify the text of the window. If Text is long, it can be broken up into several shorter lines by means of a continuation section, which might improve readability and maintainability.

Remarks

To have more control over layout and font name/color/size, use the Progress command with the zh0 option, which omits the bar and displays only text. For example: Progress, zh0 fs18, Some 18-point text to display.

Use the SplashTextOff command to remove an existing splash window.

The splash window is "always on top", meaning that it stays above all other normal windows. To change this, use WinSet, AlwaysOnTop, Off, <insert title of splash window>. WinSet can also make the splash window transparent.

WinMove can be used to reposition and resize the splash window after it has been displayed with SplashTextOn.

Unlike Progress, SplashImage, MsgBox, InputBox, FileSelectFile, and FileSelectFolder, only one SplashText window per script is possible.

If SplashTextOn is used while the splash window is already displayed, the window will be recreated with the new parameter values. However, rather than recreating the splash window every time you wish to change its title or text, better performance can be achieved by using the following, especially if the window needs to be changed frequently:

WinSetTitle, <insert title of splash window>, , NewTitle
ControlSetText, Static1, NewText, <insert title of splash window>

Progress, SplashImage, ToolTip, MsgBox, InputBox, FileSelectFile, FileSelectFolder, WinMove, WinSet

Examples

Creates a fixed-size popup window that shows the contents of the clipboard, and moves it to the upper-left corner of the screen.

SplashTextOn, 400, 300, Clipboard, The clipboard contains:`n%Clipboard%
WinMove, Clipboard,, 0, 0
MsgBox, Press OK to dismiss the SplashText
SplashTextOff

Creates a popup window that displays only a title bar.

SplashTextOn,,, Displays only a title bar.
Sleep, 2000