Plugin Win

From VoxCommando
Revision as of 11:25, 13 January 2021 by James (talk | contribs) (1 revision)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Go to the main Plugins page.

Go to the complete Plugin List.


Plugin Description

Tools to select (find), query (get) and manipulate (set) other windows and processes.

First use a Win.Find.* action to find and select a window. Then other Win.* actions will be applied to this window until another is selected using Win.Find.*

Actions for the Win plugin

Get

Actions to get information about the current window.

Info

Win.Get.Info
Returns various data about the window that is currently targeted.
Currently the information includes the name (caption), class, position and size.
Additional information may be included in future versions.

Caption

Win.Get.Caption
Returns the text caption (name) of the current window.

Class

Win.Get.Class
Returns the class of the current window.
The class can later be used to "Find" this window again using Win.Find.ByName.

Find

Actions used to find and set the current window. Other subsequent Win actions will be applied to this window.

Active

Win.Find.Active
Select the active (focused) window and process.

ByHandle

Win.Find.ByHandle
Note that windows will assigned a different handle number by the OS each time they are created.

  • Parameters: 1
  1. HWnd : Handle to the window [integer]

ByName

Win.Find.ByName
Find a window using either name (caption) or class or both.

  • Parameters: 0-2
  1. Name : Name of window (caption). Leave blank to use class only [string]
  2. Class : Class of window. Leave blank to use name only. [string]

ByProcess

Win.Find.ByProcess
Active process names can be found in Windows Task Manager.
Do not include the .exe in process name.

  • Parameters: 1
  1. ProcessName : Name of process that owns the Window [string]

BySearch

Win.Find.BySearch
Similar to Win.Find.ByName but allows for partial matching.

Although both <Name> and <Class> are optional, at least one parameter must be provided.

RegEx patterns are NOT case sensitive and whitespace is NOT ignored.

Only top level windows can be found, sub elements of Windows cannot be found. A process may have multiple top level windows.

** This action may take longer to find the window, depending on the parameters used and the number of open windows on your system. The other Win.Find actions should be almost instant.

  • Parameters: 0-2
  1. Name : RegEx pattern [string]
  2. Class : RegEx pattern [string]

Set

Actions to manipulate the current window.

Focus

Win.Set.Focus
Focus the current window

Position

Win.Set.Position
Move and optionally resize the current window.

  • Parameters: 2-5
  1. Left : Position left edge of window (X) [integer]
  2. Top : Position left edge of window (X) [integer]
  3. Width : [integer]
  4. Height : [integer]
  5. Other : [integer]

State

Win.Set.State
Change the state of the current window.
<State> must be one of the following:
Close, Minimize, Maximize, Normalize

  • Parameters: 1
  1. State : Close, Minimize, Maximize, Normalize [string]

KeyPress

Win.KeyPress
Send low-level keyboard emulation as though the user was using the keyboard.
First <ModKeys> will all be pressed and held down
then <SequenceKeys> will be pressed and released in order
Finally <ModKeys> will all be released

  • Parameters: 0-2
  1. ModKeys : [string]
  2. SequenceKeys : [string]