Go to: Synopsis. Return value. Related. Flags. MEL examples.

Synopsis

inViewMessage [-alpha float] [-assistMessage string] [-backColor uint] [-clear string] [-dragKill] [-fade] [-fadeInTime uint] [-fadeOutTime uint] [-fadeStayTime uint] [-font string] [-fontSize uint] [-frameOffset uint] [-hide] [-message string] [-minimize] [-position string] [-restore] [-show] [-statusMessage string] [-textAlpha float] [-textOffset uint]

inViewMessage is undoable, NOT queryable, and NOT editable.

Used for displaying in-view messages.

Note: On Linux, the alpha and textAlpha flags for inViewMessage are only supported when running a window manager that supports compositing (transparency and opacity). Otherwise, they are ignored. In addition, the flags for message fading: -fade, -fadeInTime, -fadeStay and -fadeOutTime are supported, but the message will display without a fade effect if the window manager doesn't support compositing.

Return value

None

Related

file, workspace

Flags

alpha, assistMessage, backColor, clear, dragKill, fade, fadeInTime, fadeOutTime, fadeStayTime, font, fontSize, frameOffset, hide, message, minimize, position, restore, show, statusMessage, textAlpha, textOffset
Long name (short name) Argument types Properties
-message(-msg) string create
The message to be displayed, can be html format. General message, inherited by -amg/assistMessage and -smg/statusMessage.
-assistMessage(-amg) string create
The user assistance message to be displayed, can be html format.
-statusMessage(-smg) string create
The status info message to be displayed, can be html format.
-position(-pos) string create
The position that the message will appear at relative to the active viewport. The supported positions are:
  • "topLeft"
  • "topCenter"
  • "topRight"
  • "midLeft"
  • "midCenter"
  • "midCenterTop"
  • "midCenterBot"
  • "midRight"
  • "botLeft"
  • "botCenter"
  • "botRight"
-clear(-cl) string create
Use this flag to clear the message at a specified position. The supported positions are the same as for the -pos/position flag.
-dragKill(-dk) create
Use this flag if the message needs to be deleted on mouse drag.
-hide(-hd) create
Hides all messages.
-show(-sh) create
Shows all messages.
-minimize(-min) create
Minimize all messages.
-restore(-res) create
Restore all messages.
-fade(-f) create
Whether the message will fade after a time interval or not.
-backColor(-bkc) uint create
Sets the background color for the message using the format 0xAARRGGBB, alpha is not taken into account.
-alpha(-a) float create
Sets the maximum alpha transparency for the message box.
-textAlpha(-ta) float create
Sets the maximum alpha transparency for the message text.
-frameOffset(-fof) uint create
Sets how far the message appears from the edge of the viewport in pixels.
-textOffset(-tof) uint create
Sets how far the text appears from the edge of the message box in pixels.
-font(-ft) string create
Sets the message to a font (eg. "Arial").
-fontSize(-fts) uint create
Sets the message font size.
-fadeInTime(-fit) uint create
Sets how long it takes for the image to fade in (milliseconds).
-fadeStayTime(-fst) uint create
Sets how long the image stays at max opacity (milliseconds).
-fadeOutTime(-fot) uint create
Sets how long it takes for the image to fade out (milliseconds).
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples

// Create a default message
//
inViewMessage;

// Create a message in the top right corner of the active viewport.
// Also set the background color to black, and set the message to fade out after the default time.
//
inViewMessage -smg "test message" -pos topRight -bkc 0x00000000 -fade;