cmdScrollFieldReporter

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

Synopsis

cmdScrollFieldReporter [-clear] [-copySelection] [-cutSelection] [-echoAllCommands boolean] [-filterSourceType string] [-hasFocus] [-lineNumbers boolean] [-pasteSelection] [-receiveFocusCommand script] [-saveSelection string] [-saveSelectionToShelf] [-select uint uint] [-selectAll] [-stackTrace boolean] [-suppressErrors boolean] [-suppressInfo boolean] [-suppressResults boolean] [-suppressStackTrace boolean] [-suppressWarnings boolean] [-text string] [-textLength]

cmdScrollFieldReporter is undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
-clear(-clr)
Clears the field.
-copySelection(-cp)
Copies the current selection from this field.
-cutSelection(-ct)
Cuts the current selection from this field.
-echoAllCommands(-eac)	boolean
Echo all commands. (Global parameter, affects all command reporters)
-filterSourceType(-fst)	string
Filters the specified source type from showing in this command reporter. Currently supports either "mel", "python", or "" (default). Setting the filter to the empty string ("") will remove all filtering and show both "mel" and "python" results.
-hasFocus(-hf)
Whether this control is currently in focus.
-lineNumbers(-ln)	boolean
Show line numbers (in Error/Warning messages). (Global parameter, affects all command reporters)
-pasteSelection(-pst)
Pastes text into this field at the current caret position.
-receiveFocusCommand(-rfc)	script
Command executed when the field receives focus.
-saveSelection(-sv)	string
Prompts to save the current selection to a file. The default filename prompt will be prepended with the given string.
-saveSelectionToShelf(-svs)
Prompts to save the current selection to an item in the shelf.
-select(-sl)	uint uint
Selects text within a specified range.
-selectAll(-sla)
Selects all text.
-stackTrace(-st)	boolean
Show stack trace. (Global parameter, affects all command reporters)
-suppressErrors(-se)	boolean
Suppress errors.
-suppressInfo(-si)	boolean
Suppress info.
-suppressResults(-sr)	boolean
Suppress results.
-suppressStackTrace(-sst)	boolean
Suppress stack trace.
-suppressWarnings(-sw)	boolean
Suppress warnings.
-text(-t)	string
Replaces the field text with the given string.
-textLength(-tl)
The number of characters in this text field.

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

// this will create a tiny window with a command history reporter
window;
    columnLayout;
        cmdScrollFieldReporter -width 200 -height 100;
showWindow;