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.

A script editor reporter control used to receive and display the history of processed commmands.

Return value

string The name of the reporter control

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

Flags

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