Keyword Index

Object: SPRichConsole

This object lets you create and control a scrolling console window with rich text display capabilities

  • setDescription - Sets the description string of the console window, which is displayed as an alternate long title which may appear when the console is frontmost or in tool tip popup windows
  • setTitle - Sets the title of the console window, which is displayed by default in the tool panel's tab and title bar. Some of this behaviour can be extended using setDescription
  • write - Writes a text string to the console using the current format
  • writeln - Writes a text string to the console followed by a new line using the current format
  • Method: setDescription

    Sets the description string of the console window, which is displayed as an alternate long title which may appear when the console is frontmost or in tool tip popup windows

    void setDescription(desc);

    Parameters
    Name Expected Type Description
    desc String The new description string for the console panel

    Method: setTitle

    Sets the title of the console window, which is displayed by default in the tool panel's tab and title bar. Some of this behaviour can be extended using setDescription

    void setTitle(title);

    Parameters
    Name Expected Type Description
    title String The new title for the console panel

    Remarks:

    The title string should normally be reasonably short as it will be displayed in the panel's tab in the usual window layout. Set description (setDescription can be used to display a longer information string

    Method: write

    Writes a text string to the console using the current format

    void write(str, ...);

    Parameters
    Name Expected Type Description
    str String Any string value to display. Any number of arguments can be provided and they will be converted to text and concatentated

    Method: writeln

    Writes a text string to the console followed by a new line using the current format

    void writeln(str, ...);

    Parameters
    Name Expected Type Description
    str String Any string value to display. Any number of arguments can be provided and they will be converted to text and concatentated