PowerPro Scripting Reference

PowerPro Scripting Reference
- Using this Reference
  - Standard syntax used
    - Abbreviations
      - PP
        PowerPro
      - PPCD
        PowerPro Control Dialog
        the GUI interface of the pproconf.exe file, PowerPro's configuration file.
      - PPSR
        PowerPro Scripting Reference
        this manual
      - wid
        window ID
        PPSR > Language Reference > Window ID's
      - cl
        caption list
        PPSR > Language Reference > Caption Lists for more information
    - Capitalisation
      - In general, PP ignores case.
      - Exceptions
        Some keywords
        "noembed"
      - For clarity & consistency in this Reference, all command & functions are written with first letter capitalised.
        Exception: "cl.xxxx" for CL functions
    - Naming
      - In the main PP Help, Bruce generally uses the term "Action" for a command method, while many of the plugins use the term "Service" -- I can't decide whether to stick with one of these or use a more generic "Function" or "Method"..?
        Consequently, all terms are used at various places throughout the manual. To be refined!
  - Getting updates
    - Updates will be posted at http://ppsr.miinx.com.au/
  - Plugins
    - Adding your plugin
      - Contact me!
        ppsr@miinx.com.au
    - I hope plugin authors don't mind that I've reprinted their info files here. Please let me know if you'd like yours removed.
  - English spelling variations
    - This is written by an Australian, so most of the text here uses Australian English, except, of course, where functions have US or other spelling.
      Exceptions: - minimize & maximize - color
    - This means there is some inconsistency, which I may address in a later version.
  - Incomplete
    - This is a work in progress with quite a few holes & lot of inconsistency at the moment, so please mind the mess as the PPSR comes together!
- Language Reference
  - Basic Syntax & Usage
    - Literal vs. Expression Syntax
      - see:
        PowerPro Help CHM > General Syntax Guidelines > Combining expressions, variables, and powerpro commands
    - PowerPro Scripts
      - Types of Scripts/Script Usage
        Entering Commands directly into the PPCD
        using PPCD's More Commands box
        Command Lists
        Script Files
        .powerpro or .txt
        Default location: <powerpro directory>/scripts
      - Calling Scripts
        from another script file or from PPCD
        .AnotherScriptFile@Label
        from same script file
        .@Label
        from within an expression
        Win.Debug(.ScriptFile@Label)
        from outside of PP
        Command Line / Windows Run box
        PPBangTwice
        PP plugin
        use to call a script from command line
        can be run even while PP is not running
      - Returning from Nested Scripts
        Quit
        Return to calling script
        Quit All
        End all running scripts, including calling script
    - Case-Sensitivity
      - Non-case sensitive
        functions
        variables
        cl Functions
        plugin calls
      - Case sensitive
        *Info keywords
        Certain function parameters
        where noted
    - ?"" syntax
      - Prevents any escaping of characters in the string.
      - The backslash has special significance in strings, but the ?"" syntax prevents any backslashes from being read incorrectly & escaping characters where it isn't intended.
      - If your quoted string contains the default string delimiter, a double quote, the ?"" syntax is again handy, as it allows the use of different delimiters for that quoted string.
      - Examples
        File.Delete(?"c:\path\to\file.ext") File.Delete(?#c:\path\to\file.ext#) File.Delete(?+c:\path\to\file.ext+)
        Each line here is equivalent.
        do(?~win.debug("something")~)
        Outputs "something" to a debug window.
    - Path separators
      - To separate the sections of a file or folder path, PowerPro allows the use of:
        a single forward slash
        "c:/path/to/file.ext"
        double back slashes
        "c:\\path\\to\\file.ext"
        a single back slash using the ?"" delimiter syntax
        ?"c:\path\to\file.ext"
  - Caption Lists
    - Used to specify one or more windows, a caption list is a comma-separated list of Window Id's.
    - Example
      - "=metapad,*notepad,c=RichTextEdit"
    - See Also
      - PPSR > Language Reference > Window ID's
  - Comments
    - Block Comments
      - /* ... */
        for scripts in files
    - Comments in scripts
      - ;
        at the start of a line
      - ;;
        after some code but still on the same line
    - Comments in PPCD
      - the More Commands box seems to require ;; to be used
    - Long Line comment
      - ;;+
        used within a long script line to break it over multiple lines
        Win.Debug("this is a really " ;;+ ++ "long sentence")
  - Control Structures
    - break
    - if, else, elseif, endif
    - for
      - for(testexpr)
    - jump
    - quit
    - label
  - Data Types
    - Data Types Supported
      - Boolean
        True or False.
        A boolean value can only be:
        1
        true, yes, "a string"
        0
        false, no, "" (empty string)
      - Number
        Parameter can be either an integer or a floating point value.
        An number can be any of:
        a positive value, e.g. 24680
        a negative value, e.g. -24680
        a string of valid numbers, e.g. "24680"
        an expression, e.g. 24*680
      - String
        All values are actually stored internally as strings.
        Must be surrounded by double quotes; single quotes are not accepted as string delimiters.
        A string can be any of:
        a text string, e.g. "abcdef"
        a variable that stores a text value, e.g. msgOut, where msgOut = "abc123"
        a string expression, e.g. "Today is" ++ formatedate("shortdate",date)
        an integer, as PowerPro stores integers as strings anyway, e.g. 27348 is the same as "27348"
      - Pseudo-types
        Mixed
        The parameter may accept multiple types (not necessarily all of them, though).
    - Notes
      - Note that when reading Syntax expressions in this reference, where a parameter is specified as a particular data type, the parameter may always be an expression that evaluates to a value of that type instead.
      - For example, where you see (string), the value could be any of:
        - a text string
        e.g. "abcdef"
        - a number, as PowerPro stores numbers as strings anyway
        e.g. 27348 is the same as "27348"
        - a string expression
        e.g. "Today is" ++ formatedate("shortdate",date)
        - a variable that stores a string value
        e.g. msgOut, where msgOut = "abc123"
  - Error Handling
    - see info at Exec.OnErrors & _LastError_
    - Avoiding Errors
      - Underscore after action
        same effect as Exclamation mark error parameter
        Avoids showing the error message if the destination window is not found
        e.g. Window.Min_("=notepad")
      - (old) Exclamation mark after action
        Prevents error if no window matches the caption
        Old syntax only; does not work with new syntax.
        e.g. *Window Close! =notepad
  - Expressions
    - Acceptable Values
      - string in double quotation marks
      - whole number (+/-)
      - variable
      - plugin call which returns a value
      - call to a script which returns a value
      - built-in keyword which returns a value
      - built-in Function which returns a value
      - another expression
    - Escape Sequences
      - \"
      - \\
      - \&
      - \n
      - \r
      - \t
      - \xhh
      - \d
      - These examples assume backslash is used as the escape character.
  - Flags
    - Description
      - PowerPro has 32 flags, n0-n31
      - Each flag can be set to 0 (false, off) or 1 (true, on).
    - Functions that set/clear flags:
      - Input dialogs
        Cancel => pproflag(0) set to 0
        else => pproflag(0) set to 1
      - Exec.Prompt
        prompt for a Yes/No answer and set a flag with the result
        e.g. Exec.Prompt(14, "question text")
        sets flag 14 to 0 or 1
    - Starting PowerPro with Flags Initialised
      - PowerPro may be started with specific flags preset.
      - "c:\program files\PowerPro\PowerPro.exe" -f6
        Starts PowerPro & sets flag 6 to "1".
  - Functions
    - Functions in PowerPro
      - Built-in Commands
      - Built-in Functions
      - CL Functions
      - Plugin Commands
      - Info Labels
        *info expr(sExpr)
        Displays the result of sExpr on a button label.
        Note this cannot be written as: info.expr(sExpr)
    - Arguments
      - Passing Arguments
        in PPCD
        =x0
        in script calls
        Omitting an argument
        in a comma-separated list of arguments, a middle argument can be omitted by either:
        cmd.axn(p1,p2,,p4)
        entering nothing in that parameter's place
        cmd.axn(p1,p2,"",p4)
        empty string
      - Retrieving Arguments
        arg(0) ... arg(7)
    - Returning values
      - Run/RunFile VS Run./RunFile.
      - Quit (expr)
      - Jump (expr)
    - Script Labels
  - Operators
    - Operator Precedence
      - level 0 - nots
        not
        ~
      - level 1 - products
        *
        /
        %
      - level 2 - sums
        +
        -
        ++
      - level 3 - comparison operators
        ==
        ===
        !=
        !==
        <
        <=
        >
        >=
      - level 4 - and
        &&, and
      - level 5 - or
        ||, or
    - Mathematical Operators
      - *
        multiplication
      - /
        division
      - %
        modulo
      - +
        addition
      - -
        subtraction
      - ++
        increment
        requires minimum PowerPro version 4.4.12
        Example:
        count++
        equivalent to count=count+1
      - --
        decrement
        requires minimum PowerPro version 4.4.12
        Example:
        count--
        equivalent to count=count-1
    - Logical Operators
      - not
      - ~
        bitwise not
      - ==
        equal
        Old Format
        eq
      - ===
        Identical
        Always compares as string, e.g.:
        "99"=="099"
        is true
        "99"==="099"
        is false
      - !=
        not equal
        Old Format
        ne
      - !==
        not identical
        Compare as strings:
        "99" !== "099"
        is 1
        "99" != "099"
        is 0
        99 !== 099
        is 0
        99 != 099
        is 0
      - <
        less than
        Old Format
        lt
      - <=
        less than or equal to
        Old Format
        le
      - >
        greater than
        Old Format
        gt
      - >=
        greater than or equal to
        Old Format
        ge
      - &&
        logical and
        Old Format
        and
      - ||
        logical or
        Old Format
        or
    - String Operators
      - ++
        concatenation
  - Variables
    - Order of Evaluation
      - 1. each value
      - 2. parentheses
      - 3. operators, from L to R
    - Predefined Globals
      - _Exit_
        Definition
        Set when a PP or plugin command completes execution.
        Used By
        File.RunCallBack
        set to
        9999999
        maxwait is exceeded
        exit code
        otherwise
        Event.Message
        set to
        1
        countdown finished
        0
        Start Now pressed
      - _LastError_
        Definition
        When an error occurs, this is set to the error message.
        To clear _LastError_
        _LastError_ = ""
        Exec.OnErrors("clear")
        Notes
        see Error Handling & Exec.OnErrors for more information about errors.
      - _PickedLine_
        index of picked file or string in:
        s = pickfile(paths, title)
        s = pickstring(lines, title)
        indices start at 1
      - Context
        set to 0 for processing of the first file in a list of files
        should be then set to 1 within script when processing the file
      - ContextLast
        set to 0 at start of processing of a list of files
        set to 1 just before command executed on the last file
    - Priority
      - 1. Priority is local, static , global once declarations are executed. I recommend avoiding local and static with same name.
      - 2. You cannot declare static if local already exists.
      - 3. The declaration must be executed to take effect. Its not enough that it appear in the file as PowerPro does not do any type of compilation or prescanning. You should declare statics at every entry point or call at initialize entry point to declare them.
      - 4. For statics, the same memory is used whenever it is referenced in the script and once the static is declared, it will be used at any entry point. For locals, each time the script is entered at a new entry point, the local must be declared and different memory is used.
      - notes from Bruce on PPro list 18/11/04
    - Standard Variable Types
      - Local
        Known only in the script file/command list that creates them.
      - Static
        Known only in the script file/command list that creates them.
        Retain their value after the script exits.
      - Global
        Default variable type.
        Accessible from anywhere.
    - Other Variables
      - Maps & Vectors
        see:
        PPSR > Plugins > Map
        PPSR > Plugins > Vec
      - Mouse Position
        @bottom
        @bottomleft
        @bottomright
        @left
        @quadtopleft
        @quadtopright
        @quadbottomleft
        @quadbottomright
        @right
        @top
        @topleft
        @topright
    - Undeclared Variables
      - if a new variable doesn't exist, it is created as a Global
      - Setting declaration preferences
        It is good practice to always declare variables.
        The setting "Variables must be declared" in PPCD > Setup > Advanced >Other, can be changed to toggle variable declaration requirement.
  - Window ID's
    - To refer to a window, you can use the window's ID, which can be represented in a few different ways.
    - Formats
      - Class
        c=*PartOfClassName*
      - Process Id
        p=pid
      - Program Exe
        =exename
        +exename
        nodialog
        add as last parameter to exclude program configuration dialogs
      - Keyword
        Usage
        Keywords are strings so must be in quotes.
        Possible Values
        active
        The currently active window, also called the foreground window.
        Ignores the Taskbar, or any PP bars or menus. See rawactive for these.
        activebar
        Last window selected via a button from an active windows bar.
        autorun
        Last window matched by autorun command list.
        Use this for commands in autorun command lists.
        explorer
        Match single or dual pane explorer windows.
        explorer1
        Single pane explorer windows.
        explorer2
        Dual-pane explorer windows.
        filedialog
        File open/save/save as windows.
        rawactive
        Always refers to the active window.
        Differs from "active" in that "active" actually refers to the active window before a button or taskbar is pressed, so ignores the fact that the active window is actually the button's bar or the taskbar, etc.
        taskbar
        The taskbar.
        under
        The window currently under the mouse.
        Example
        Win.Right("under")
      - Window Caption
        cccc
        cccc*
        *cccc
        cc*cc
        *cccc*
      - Window Handle
        Every window is assigned a unique number by the Windows operating system, called the "window handle".
        For methods of retrieving a window's handle, see:
        Win plugin
        PPSR > Plugins > Win > Commands > by Category > Windows > Get Window Information > Handle
        built-in functions
        window
        LastActiveHandle
        LastAutorunHandle
    - Getting a Window's ID
      - Some information is clearly visible:
        caption
        (if it has one) is what appears in the window's titlebar
        program exe
        check Task Manager:
        <ctrl>+<shift>+<esc>.
      - PowerPro has various commands available:
        Exec.WindowInfo
        PPSR > Built-in Commands > Exec > Functions by category > Window > WindowInfo
        built-in functions
        window
        LastActiveHandle
        LastAutorunHandle
        various commands in the Win plugin
        PPSR > Plugins > Win > Commands > by Category > Windows > Get Window Information
- Built-in Commands
- Built-in Functions
- CL Functions
- Plug-ins
- Miscellaneous
  - Hooks
    - What are they?
      - hooks into stuff the Windows operating system does
    - Setting up hook scripts
    - Types of Hooks
      - HookWindowsEvents
      - HookSystemEvents
        Called with a single argument after certain system events: .FileHookSystem(arg(1))
        arg(1) - possible values:
        1
        Power suspended.
        2
        Power resumed after suspension.
        10
        Display resolution changed
      - HookCommandLine
      - HookErrors
    - Turning them off
      - Possible reasons for wanting to turn them off...?
      - How to
        Turn them off by putting 15 in setup|advanced|other|hook code
      - WARNING
        Turning global hooks off will break many PowerPro features
  - Info Labels
    - context for *Info
      - Name field of item
      - Tooltip
    - keywords
      - time & date
        offset
        shortdate
        longdate
        d, dd, ddd, dddd
        M, MM, MMM, MMMM
        yy, yyyy
        w, ww
        daynum
        time
        h, hh, H, HH
        m, mm
        s, ss
        t, tt
      - resources
        gdi
        user
        pkmem
        pmem
        ppmem
        vkmem
        vmem
        cpu
        swap
        swapinuse
        pswapinuse
        dunin
        dunout
        dunrate
        battery
        allbattery
        percent remaining
        charging status
        AC/DC status
      - other
        cdcurtrack
        cdlasttrack
        clip
        defaultprinter
        deskname
        desknum
        disk
        expr(expression)
        keylog
        keylogfile
        subbarname
        timer
        timerdays
        timersec
        uptime
        uptimedays
        uptimedhm
        uptimedhms
        uptimesec
    - Notes on Info Labels
      - only update once per second
      - to force update, try: Bar.Format("Bar_Name","Refresh")
  - Skins
    - Skin Files
    - Skin Commands
    - Sections & Subbars for Skins
  - Filetype associations
    - between extension .ppronote and powerpro.exe
      - From a command prompt, enter the following:
        C:\> assoc .ppronote .ppronote=PowerPro.Note
        C:\> ftype powerpro.note powerpro.note=C:\PROGRA~1\PowerPro\PowerPro.exe *Note Open File "%1"
        [from "Re: Notes Problem" sgp's msg to PowerPro List 9/3/05]
  - Dropping Files on a Button
    - Buttons can be clicked, hovered over (which initiates an automatic click), or have files dropped onto them.
    - To create a button which determines the correct action before processing, use the following script for the button's action:
      - .myscript (?*|*)
        where script "myscript" contains: args files if (length(files)==1) do ;; stuff for button press else ;; stuff for files dropped on button endif
    - Note: there is a limit of about 500 characters for the total length of all dropped files plus all the commands (include those in more commands).
- Script Writing Tips
  - PowerPro always searches script files sequentially for @ labels, therefore to minimise overhead, put the most common call first.
- Other PowerPro Help
  - HTML Help for PowerPro
    - the main PowerPro Help manual
    - installed with PowerPro into PowerPro directory
  - PowerPro Scripting Tutorial
    - Alexander Cicovic's excellent tutorial giving an introduction to scripting in PowerPro.
    - installed with PowerPro into PowerPro directory
  - Online Help
    - PowerPro Home Page
      - http://www.ppro.org/
    - Repository of PowerPro manuals, plugins, tutorials & more
      - http://powerpro.pcrei.com/
      - maintained by David Treosch
    - PowerPro Scripts for Total Commander
      - http://ppro.totalcmd.net/
    - Online version of this PPSR
      - http://www.ppsr.info/
  - Mailing Lists
    - Yahoo Mailing List
      - http://groups.yahoo.com/group/powerpro/
    - Gmane copy of the Yahoo list
      - http://news.gmane.org/gmane.comp.windows.power%2dpro
      - more powerful search capabilities
- Credits
  - Bruce Switzer
    - The creator & developer, Bruce writes & maintains PowerPro for a hobby.
    - Additionally, Bruce also devotes much time to the PowerPro lists, assisting others in their learning, answering general and specific questions about PowerPro and Windows, debugging problems, and fielding & implementing feature suggestions and improvements.
  - PP Discussion List
    - The PP mailing lists have been around for a lot longer than I've been using PowerPro, and many others would have participated than I am aware of. I am ever grateful to anyone who shares their PP knowledge and helps us all benefit from this truly amazing program.
    - Bruce Switzer
    - Alan Campbell
    - Alan Martin
    - Alex Peters
    - bizaro
    - Cüneyt
    - David Treosch
    - Mockey
    - Sean
    - sgp
    - & so many more...
- Appendix
  - Menu.Folder() Formatting Keywords
    - Keywords, Detailed List in AlphaOrder
      - *all
        Execute all commands/programs in folderPath, rather than displaying a menu.
      - *allclose
        Close all commands/programs in folderPath, rather than displaying a menu.
      - *allcloseforce
        Force closed all commands/programs in folderPath, rather than displaying a menu.
      - autocol n
        Automatically starts a new column every n+1 entries.
        Applies to top level menu only.
      - autocolall n
        Automatically starts a new column every n+1 entries.
        Applies to top level menu & submenus.
      - autosoftcol n
        Automatically starts a new column every n+1 entries, without including a bar between the columns.
        Applies to top level menu only.
      - autosoftcolall n
        Automatically starts a new column every n+1 entries, without including a bar between the columns.
        Applies to top level menu and submenus.
      - back
        Bar or menu takes the default background defined in PPCD > Command Lists > Setup.
      - center
        Centers menu on screen.
      - cmd 'cmdline' 'params'
        Defines a command line & parameters to be executed with the selected file, where:
        'cmdline'
        command to be executed, in single quotes
        'params'
        parameters for 'cmdline', in single quotes
        Use the _file_ variable or a "|" to indicate where the selected file is to be placed in the command line.
        The command line & parameter strings that appear after the "cmd" keyword can optionally be enclosed in nested single quotes, unless the strings contain spaces, in which case single quotes must be used.
        Example
        Menu.Folder("desktop", "cmd 'c:\program files\2x\2xExplorer' '|*'")
      - empty
        Empty folders will be included in the menu (normally, they are excluded).
      - exclude \"folders_list\"
        Excludes all folders listed in folders_list, a comma-separated list of folders.
        Examples
        Menu.Folder(?"c:\temp", "exclude \"c:\\temp\\store, c:\\temp\\logs\"")
        Shows a menu of the "c:\temp" directory, excluding the "store" and "logs" folders.
        Menu.Folder(?"c:\temp", ?#exclude "c:\temp\store, c:\temp\logs"#)
        Shows a menu of the "c:\temp" directory, excluding the "store" and "logs" folders.
        Doesn't work with other exclusion-type keywords:
        nofiles
        nofolders
        nosubdir
        nosubmenu
      - explorer
        Adds a menu entry with label "Explore" at the top of all submenus, a shortcut to open a single-paned Explorer window.
        The entry can be:
        left-clicked
        to open a single-paned Explorer window on the selected directory
        right-clicked
        to show a Menu.Folder() menu for that folder, useful if files are not being displayed in the current menu.
        Am getting an error when right-clicking explorer entry:
        Cannot access context menu for: c:\docs & settings\username\start menu\programs\ Error occurred near line 1 which contained: Menu.Folder("programs", "explorer fileman \"open in explorer\" ")
      - explorer2
        Adds a menu entry with label "Explore" at the top of all submenus, a shortcut to open a double-paned Explorer window.
        The entry can be:
        left-clicked
        to open a double-paned Explorer window at the selected directory
        right-clicked
        to show a Menu.Folder() menu for that folder, useful if files are not being displayed in the current menu.
      - fileman \"lbl\"
        Where lbl = label for the optional top item of submenus, created when the "explorer" keyword is included.
        The "explorer" keyword must also be included in sFormat whenever "fileman" is used.
        Example
        Menu.Folder("programs", "explorer fileman \"Open in Explorer...\" ")
      - folderback
        Adds a "Back" entry to the top of the menu, to go back to previous folder.
        Only useful when NoSubDir is specified.
      - folderdots
        Adds "..." to folder names.
        Useful to highlight folders when NoSubDir is specified & icons are not used in menus.
      - foldershorcut
        Expands all folder shortcuts in the menu.
      - foldershorcuts2
        Expands foldershortcuts with names ending in "_x".
      - folderstart
        Sorts menu entries so that folders are at the start.
      - noicons
        Omits menu icons.
        Only works if the Menu.Folder() command is not embedded in another menu.
      - maxtext n
        Limits text labels to n characters.
      - mne
        Powerpro assigns single character menu mnemonics to the first 36 items on the main menu, allowing them to be easily selected with the keyboard.
      - noext
        File extensions are removed from menu item labels.
      - nofiles
        Files are not displayed, only folders.
        Useful with the "explorer" option to traverse large folder trees quickly.
      - nofolders
        Omit all subfolders.
      - nosort
        Menu items will not be sorted.
      - nosubdir
        Dynamic subdirectories (that appear when the parent items are moused over) are not included.
        The names of subdirectories are still shown, & if selected, a Menu.Folder() is shown for that subdirectory.
        Doesn't work with "exclude" keyword.
      - nosubmenu
        All files from all subdirectories will be listed in the main menu.
        No folders are shown.
      - offset n1 n2
        Positions the menu offset n1 characters to the right, & n2 characters below the mouse cursor.
        n1 & n2 can be negative.
      - omit
        Deletes the phrases in the "Omit strings..." edit box on the PProConf > Command Lists > Setup > All Bars and Menus > Config tab.
        "omit" is applied before "maxtext n", if both are specified.
      - sortext
        Menu items are sort by file extension.
      - sorttime
        Sorts most recently change files to the start of the menu.
      - tipall
        Shows up to 6 lines of the file contents in the tool tip.
        Some file types (text-based, such as .txt, .html, .ini) work better than others (such as .exe) with this keyword.
      - tiptext
        Shows up to 6 lines of .txt file contents on tool tip.
      - tool tips
        Shows tool tips, regardless of PProConf setting on Tool Tip Setup dialog.
      - under
        Centers the menu under the mouse.
      - Zero \"vars_list\"
        vars_list = space-separated list of variables to be set to 0 before the files are processed.
    - Keywords List by Category
      - Execution
        *all
        *allclose
        *allcloseforce
        cmd 'cmdline' 'params'
      - Explorer
        explorer
        explorer2
        fileman \"lbl\"
      - Menu Position
        center
        embed
        offset n1 n2
        under
      - Subfolders & File Inclusion
        empty
        exclude \"folders_list\"
        folderback
        folderdots
        foldershorcut
        foldershorcuts2
        folderstart
        n
        file date
        nofolders
        nosubdir
        nosubmenu
        File Extensions
        Files can be included &/or excluded by listing them, with a "-" char in front of those to be excluded.
      - Menu Formatting
        autocol n
        autocolall n
        autosoftcol n
        autosoftcolall n
        nofiles
        noicons
        nosort
        sortext
        sorttime
      - Text Labels
        back
        maxtext n
        mne
        noext
        omit
      - Tool Tips
        tipall
        tiptext
        tool tips
      - Initialise Variables
        zero \"v1 v2 ...vn\"
  - Win.Keys() & Win.SendKeys() Keycodes
    - Overview
      - Any combination of alphanumeric characters & PowerPro key codes, as specified below, may be passed as keys to Win.Keys() and Win.SendKeys().
      - Key codes can take any of 3 formats, where each variation is equivalent:
        long
        {caret}
        shorter 2-char form
        {ca}
        symbol form
        {^}
    - Key Codes: by Category
      - Ascii Characters
        {nnn}
        first n cannot be zero
        {alt}{pad0}{pad1}{pad8}{pad1}{alt}
        To enter ascii characters in this way, some systems may require:
        "Use fast send keys" to be unchecked in PProConf > Setup > Advanced > Other
        the sequence to be preceded with {slow}
      - Date & Time
        {dateshort}
        {ds}
        {datelong}
        {dl}
        {nextshort}
        {ns}
        {prevshort}
        {ps}
        short form not working
        {time}
        {ti}
        removing the seconds
      - Keyboard
        sorted by shortcut
        {ad}
        {down}
        arrow down
        {al}
        {left}
        arrow left
        {ap}
        {apps}
        apps key
        {ar}
        {right}
        arrow right
        {au}
        {up}
        arrow up
        {ba}
        {back}
        backspace
        {br}
        {{}
        {brace}
        open curly bracket
        close curly bracket can be written directly
        {ca}
        {caret}
        {^}
        {cl}
        {capslock}
        requires {slow}
        {de}
        {del}
        {ed}
        {end}
        {en}
        {enter}
        {es}
        {esc}
        {f1}...{f12}
        {gt}
        {greater}
        {ho}
        {home}
        {in}
        {ins}
        {lt}
        {less}
        {pd}
        {pgdn}
        {pe}
        {percent}
        {%}
        {pl}
        {plus}
        {+}
        {pu}
        {pgup}
        {printscreen}
        added in 4.2.07
        no shortcut form
        {qn}
        {question}
        {qu}
        {quote}
        {sl}
        {scrolllock}
        requires {slow}
        {sp}
        {space}
        {ta}
        {tab}
        sorted by full name
        {apps}
        {ap}
        apps key
        {back}
        {ba}
        backspace
        {brace}
        {br}
        {{}
        open curly bracket
        close curly bracket can be written directly
        {capslock}
        {cl}
        requires {slow}
        {caret}
        {ca}
        {^}
        {del}
        {de}
        {down}
        {ad}
        {esc}
        {es}
        {end}
        {ed}
        {enter}
        {en}
        {f1}...{f12}
        {home}
        {ho}
        {ins}
        {in}
        {greater}
        {gt}
        {left}
        {al}
        {less}
        {lt}
        {pgdn}
        {pd}
        {pgup}
        {pu}
        {percent}
        {pe}
        {%}
        {plus}
        {pl}
        {+}
        {printscreen}
        added in 4.2.07
        no short form
        {question}
        {qn}
        {quote}
        {qu}
        return -- see enter
        {right}
        {ar}
        {scrolllock}
        {sl}
        requires {slow}
        {space}
        {sp}
        {tab}
        {ta}
        {up}
        {au}
      - Keypad
        {pad0} ... {pad9}
        {p0} ... {p9}
        {pad+}
        {p+}
        {pad-}
        {p-}
        {pad*}
        {p*}
        {pad/}
        {p/}
      - Non-keyboard Keys
        {fast}
        {slow}
        {var} {sv}
        see do( )
        {w1}...{w9}
        Inserts a wait of length 0.1-0.9 seconds
      - Obsolete
        {cmdsep}
        {cs}
        {clip}
        {cc}
        {param}
        {pp}
      - Prefix Modifiers
        %
        Alt
        ^
        Ctrl
        +
        Shift
      - Sticky Modifiers
        {alt}
        {at}
        {ctrl}
        {co}
        {shift}
        {sh}
        {win}
        {wi}
    - Sending multiples of a key
      - Win.Keys("{zzz n}")
        where:
        zzz
        key code
        n
        number of repetitions
    - Ensuring a modifier key is up
      - Alt:
        KeyTrap.SendKeys(56, 164, 1)
      - Control:
        KeyTrap.SendKeys(29, 162, 1)
      - Shift:
        KeyTrap.SendKeys(42, 160, 1)
      - Win:
        KeyTrap.SendKeys(91, 91, 1)
      - For more information about KeyTrap.SendKeys(), see:
        PPSR > Plugins > The Plugins > KeyTrap > SendKeys
  - Windows API Message Codes QuickRef
    - Alpha-order
      - WM_A - WM_C
        WM_APP
        32768
        WM_ACTIVATE
        6
        WM_ACTIVATEAPP
        28
        WM_AFXFIRST
        864
        WM_AFXLAST
        895
        WM_ASKCBFORMATNAME
        780
        WM_CANCELJOURNAL
        75
        WM_CANCELMODE
        31
        WM_CAPTURECHANGED
        533
        WM_CHANGECBCHAIN
        781
        WM_CHAR
        258
        WM_CHARTOITEM
        47
        WM_CHILDACTIVATE
        34
        WM_CLEAR
        771
        WM_CLOSE
        16
        WM_COMMAND
        273
        WM_COMMNOTIFY (obsolete)
        68
        WM_COMPACTING
        65
        WM_COMPAREITEM
        57
        WM_CONTEXTMENU
        123
        WM_COPY
        769
        WM_COPYDATA
        74
        WM_CREATE
        1
        WM_CTLCOLORBTN
        309
        WM_CTLCOLORDLG
        310
        WM_CTLCOLOREDIT
        307
        WM_CTLCOLORLISTBOX
        308
        WM_CTLCOLORMSGBOX
        306
        WM_CTLCOLORSCROLLBAR
        311
        WM_CTLCOLORSTATIC
        312
        WM_CUT
        768
      - WM_D - WM_I
        WM_DEADCHAR
        259
        WM_DELETEITEM
        45
        WM_DESTROY
        2
        WM_DESTROYCLIPBOARD
        775
        WM_DEVICECHANGE
        537
        WM_DEVMODECHANGE
        27
        WM_DISPLAYCHANGE
        126
        WM_DRAWCLIPBOARD
        776
        WM_DRAWITEM
        43
        WM_DROPFILES
        563
        WM_ENABLE
        10
        WM_ENDSESSION
        22
        WM_ENTERIDLE
        289
        WM_ENTERMENULOOP
        529
        WM_ENTERSIZEMOVE
        561
        WM_ERASEBKGND
        20
        WM_EXITMENULOOP
        530
        WM_EXITSIZEMOVE
        562
        WM_FONTCHANGE
        29
        WM_GETDLGCODE
        135
        WM_GETFONT
        49
        WM_GETHOTKEY
        51
        WM_GETICON
        127
        WM_GETMINMAXINFO
        36
        WM_GETTEXT
        13
        WM_GETTEXTLENGTH
        14
        WM_HANDHELDFIRST
        856
        WM_HANDHELDLAST
        863
        WM_HELP
        83
        WM_HOTKEY
        786
        WM_HSCROLL
        276
        WM_HSCROLLCLIPBOARD
        782
        WM_ICONERASEBKGND
        39
        WM_INITDIALOG
        272
        WM_INITMENU
        278
        WM_INITMENUPOPUP
        279
        WM_INPUTLANGCHANGE
        81
        WM_INPUTLANGCHANGEREQUEST
        80
      - WM_K - WM_M
        WM_KEYDOWN
        256
        WM_KEYFIRST
        256
        WM_KEYLAST
        264
        WM_KEYUP
        257
        WM_KILLFOCUS
        8
        WM_LBUTTONDOWN
        513
        WM_LBUTTONUP
        514
        WM_LBUTTONDBLCLK
        515
        WM_MBUTTONDOWN
        519
        WM_MBUTTONUP
        520
        WM_MBUTTONDBLCLK
        521
        WM_MDIACTIVATE
        546
        WM_MDICASCADE
        551
        WM_MDICREATE
        544
        WM_MDIDESTROY
        545
        WM_MDIGETACTIVE
        553
        WM_MDIICONARRANGE
        552
        WM_MDIMAXIMIZE
        549
        WM_MDINEXT
        548
        WM_MDIREFRESHMENU
        564
        WM_MDIRESTORE
        547
        WM_MDISETMENU
        560
        WM_MDITILE
        550
        WM_MEASUREITEM
        44
        WM_MENUCHAR
        288
        WM_MENUSELECT
        287
        WM_MOUSEACTIVATE
        33
        WM_MOUSEFIRST
        512
        WM_MOUSEHOVER
        0x2A1
        WM_MOUSELAST
        522
        WM_MOUSELEAVE
        0x2A3
        WM_MOUSEMOVE
        512
        WM_MOUSEWHEEL
        522
        WM_MOVE
        3
        WM_MOVING
        534
      - WM_N - WM_Q
        WM_NCACTIVATE
        134
        WM_NCCALCSIZE
        131
        WM_NCCREATE
        129
        WM_NCDESTROY
        130
        WM_NCHITTEST
        132
        WM_NCLBUTTONDBLCLK
        163
        WM_NCLBUTTONDOWN
        161
        WM_NCLBUTTONUP
        162
        WM_NCMBUTTONDBLCLK
        169
        WM_NCMBUTTONDOWN
        167
        WM_NCMBUTTONUP
        168
        WM_NCMOUSEMOVE
        160
        WM_NCPAINT
        133
        WM_NCRBUTTONDBLCLK
        166
        WM_NCRBUTTONDOWN
        164
        WM_NCRBUTTONUP
        165
        WM_NEXTDLGCTL
        40
        WM_NEXTMENU
        531
        WM_NOTIFY
        78
        WM_NOTIFYFORMAT
        85
        WM_NULL
        85
        WM_PAINT
        15
        WM_PAINTCLIPBOARD
        777
        WM_PAINTICON
        38
        WM_PALETTECHANGED
        785
        WM_PALETTEISCHANGING
        784
        WM_PARENTNOTIFY
        528
        WM_PASTE
        770
        WM_PENWINFIRST
        896
        WM_PENWINLAST
        911
        WM_POWER
        72
        WM_POWERBROADCAST
        536
        WM_PRINT
        791
        WM_PRINTCLIENT
        792
        WM_QUERYDRAGICON
        55
        WM_QUERYENDSESSION
        17
        WM_QUERYNEWPALETTE
        783
        WM_QUERYOPEN
        19
        WM_QUEUESYNC
        35
        WM_QUIT
        18
        WM_NEXTMENU
        531
      - WM_R - WM_W
        WM_RBUTTONDBLCLK
        518
        WM_RBUTTONDOWN
        516
        WM_RBUTTONUP
        517
        WM_RENDERALLFORMATS
        774
        WM_RENDERFORMAT
        773
        WM_SETCURSOR
        32
        WM_SETFOCUS
        7
        WM_SETFONT
        48
        WM_SETHOTKEY
        50
        WM_SETICON
        128
        WM_SETREDRAW
        11
        WM_SETTEXT
        12
        WM_SETTINGCHANGE
        26
        WM_SHOWWINDOW
        24
        WM_SIZE
        5
        WM_SIZECLIPBOARD
        779
        WM_SIZING
        532
        WM_SPOOLERSTATUS
        42
        WM_STYLECHANGED
        125
        WM_STYLECHANGING
        124
        WM_SYNCPAINT
        136
        WM_SYSCHAR
        262
        WM_SYSCOLORCHANGE
        21
        WM_SYSCOMMAND
        274
        WM_SYSDEADCHAR
        263
        WM_SYSKEYDOWN
        260
        WM_SYSKEYUP
        261
        WM_TCARD
        82
        WM_TIMECHANGE
        30
        WM_TIMER
        275
        WM_UNDO
        772
        WM_USER
        1024
        WM_USERCHANGED
        84
        WM_VKEYTOITEM
        46
        WM_VSCROLL
        277
        WM_VSCROLLCLIPBOARD
        778
        WM_WINDOWPOSCHANGED
        71
        WM_WINDOWPOSCHANGING
        70
        WM_WININICHANGE
        26
    - Num-order
      - 0x...
        0x2A1
        WM_MOUSEHOVER
        0x2A3
        WM_MOUSELEAVE
      - 0-99
        1
        WM_CREATE
        2
        WM_DESTROY
        3
        WM_MOVE
        5
        WM_SIZE
        6
        WM_ACTIVATE
        7
        WM_SETFOCUS
        8
        WM_KILLFOCUS
        10
        WM_ENABLE
        13
        WM_GETTEXT
        14
        WM_GETTEXTLENGTH
        15
        WM_PAINT
        11
        WM_SETREDRAW
        12
        WM_SETTEXT
        16
        WM_CLOSE
        17
        WM_QUERYENDSESSION
        18
        WM_QUIT
        19
        WM_QUERYOPEN
        20
        WM_ERASEBKGND
        21
        WM_SYSCOLORCHANGE
        22
        WM_ENDSESSION
        24
        WM_SHOWWINDOW
        26
        WM_SETTINGCHANGE
        26
        WM_WININICHANGE
        27
        WM_DEVMODECHANGE
        28
        WM_ACTIVATEAPP
        29
        WM_FONTCHANGE
        30
        WM_TIMECHANGE
        31
        WM_CANCELMODE
        32
        WM_SETCURSOR
        33
        WM_MOUSEACTIVATE
        34
        WM_CHILDACTIVATE
        35
        WM_QUEUESYNC
        36
        WM_GETMINMAXINFO
        38
        WM_PAINTICON
        39
        WM_ICONERASEBKGND
        40
        WM_NEXTDLGCTL
        42
        WM_SPOOLERSTATUS
        43
        WM_DRAWITEM
        44
        WM_MEASUREITEM
        45
        WM_DELETEITEM
        46
        WM_VKEYTOITEM
        47
        WM_CHARTOITEM
        48
        WM_SETFONT
        49
        WM_GETFONT
        50
        WM_SETHOTKEY
        51
        WM_GETHOTKEY
        55
        WM_QUERYDRAGICON
        57
        WM_COMPAREITEM
        65
        WM_COMPACTING
        68
        WM_COMMNOTIFY (obsolete)
        70
        WM_WINDOWPOSCHANGING
        71
        WM_WINDOWPOSCHANGED
        72
        WM_POWER
        74
        WM_COPYDATA
        75
        WM_CANCELJOURNAL
        78
        WM_NOTIFY
        80
        WM_INPUTLANGCHANGEREQUEST
        81
        WM_INPUTLANGCHANGE
        82
        WM_TCARD
        83
        WM_HELP
        84
        WM_USERCHANGED
        85
        WM_NOTIFYFORMAT
        85
        WM_NULL
      - 100-199
        123
        WM_CONTEXTMENU
        124
        WM_STYLECHANGING
        125
        WM_STYLECHANGED
        126
        WM_DISPLAYCHANGE
        127
        WM_GETICON
        128
        WM_SETICON
        129
        WM_NCCREATE
        130
        WM_NCDESTROY
        131
        WM_NCCALCSIZE
        132
        WM_NCHITTEST
        133
        WM_NCPAINT
        134
        WM_NCACTIVATE
        135
        WM_GETDLGCODE
        136
        WM_SYNCPAINT
        160
        WM_NCMOUSEMOVE
        161
        WM_NCLBUTTONDOWN
        162
        WM_NCLBUTTONUP
        163
        WM_NCLBUTTONDBLCLK
        164
        WM_NCRBUTTONDOWN
        165
        WM_NCRBUTTONUP
        166
        WM_NCRBUTTONDBLCLK
        167
        WM_NCMBUTTONDOWN
        168
        WM_NCMBUTTONUP
        169
        WM_NCMBUTTONDBLCLK
      - 200-299
        256
        WM_KEYDOWN
        256
        WM_KEYFIRST
        257
        WM_KEYUP
        258
        WM_CHAR
        259
        WM_DEADCHAR
        260
        WM_SYSKEYDOWN
        261
        WM_SYSKEYUP
        262
        WM_SYSCHAR
        263
        WM_SYSDEADCHAR
        264
        WM_KEYLAST
        272
        WM_INITDIALOG
        273
        WM_COMMAND
        274
        WM_SYSCOMMAND
        275
        WM_TIMER
        276
        WM_HSCROLL
        277
        WM_VSCROLL
        278
        WM_INITMENU
        279
        WM_INITMENUPOPUP
        287
        WM_MENUSELECT
        288
        WM_MENUCHAR
        289
        WM_ENTERIDLE
      - 300-399
        306
        WM_CTLCOLORMSGBOX
        307
        WM_CTLCOLOREDIT
        308
        WM_CTLCOLORLISTBOX
        309
        WM_CTLCOLORBTN
        310
        WM_CTLCOLORDLG
        311
        WM_CTLCOLORSCROLLBAR
        312
        WM_CTLCOLORSTATIC
      - 400-499
      - 500-599
        512
        WM_MOUSEFIRST
        512
        WM_MOUSEMOVE
        513
        WM_LBUTTONDOWN
        514
        WM_LBUTTONUP
        515
        WM_LBUTTONDBLCLK
        516
        WM_RBUTTONDOWN
        517
        WM_RBUTTONUP
        518
        WM_RBUTTONDBLCLK
        519
        WM_MBUTTONDOWN
        520
        WM_MBUTTONUP
        521
        WM_MBUTTONDBLCLK
        522
        WM_MOUSELAST
        522
        WM_MOUSEWHEEL
        528
        WM_PARENTNOTIFY
        529
        WM_ENTERMENULOOP
        530
        WM_EXITMENULOOP
        531
        WM_NEXTMENU
        532
        WM_SIZING
        533
        WM_CAPTURECHANGED
        534
        WM_MOVING
        536
        WM_POWERBROADCAST
        537
        WM_DEVICECHANGE
        544
        WM_MDICREATE
        545
        WM_MDIDESTROY
        546
        WM_MDIACTIVATE
        547
        WM_MDIRESTORE
        548
        WM_MDINEXT
        549
        WM_MDIMAXIMIZE
        550
        WM_MDITILE
        551
        WM_MDICASCADE
        552
        WM_MDIICONARRANGE
        553
        WM_MDIGETACTIVE
        560
        WM_MDISETMENU
        561
        WM_ENTERSIZEMOVE
        562
        WM_EXITSIZEMOVE
        563
        WM_DROPFILES
        564
        WM_MDIREFRESHMENU
      - 600-699
      - 700-799
        768
        WM_CUT
        769
        WM_COPY
        770
        WM_PASTE
        771
        WM_CLEAR
        772
        WM_UNDO
        773
        WM_RENDERFORMAT
        774
        WM_RENDERALLFORMATS
        775
        WM_DESTROYCLIPBOARD
        776
        WM_DRAWCLIPBOARD
        777
        WM_PAINTCLIPBOARD
        778
        WM_VSCROLLCLIPBOARD
        779
        WM_SIZECLIPBOARD
        780
        WM_ASKCBFORMATNAME
        781
        WM_CHANGECBCHAIN
        782
        WM_HSCROLLCLIPBOARD
        783
        WM_QUERYNEWPALETTE
        784
        WM_PALETTEISCHANGING
        785
        WM_PALETTECHANGED
        786
        WM_HOTKEY
        791
        WM_PRINT
        792
        WM_PRINTCLIENT
      - 800-899
        856
        WM_HANDHELDFIRST
        863
        WM_HANDHELDLAST
        864
        WM_AFXFIRST
        895
        WM_AFXLAST
        896
        WM_PENWINFIRST
      - 900+
        911
        WM_PENWINLAST
        1024
        WM_USER
        32768
        WM_APP