This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
function:WINDOW [2017/03/05 21:24] peternlewis [Forum] |
function:WINDOW [2019/12/24 22:52] JMichaelTX |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | The WINDOW() function takes one or two parameters and returns information about a window. With one parameter, it refers to the window that that action is operating on in actions like the [Manipulate a Window](action:Manipulate a Window). If the action does not refer to a window, then the function refers to the main/focused/front window. With two parameters, the first parameter specifies which window in the front application to operate on. | + | **The `WINDOW()` function returns the desired coordinate of the specified window**, and can have one or two parameters. \\ |
+ | Like all [[:Functions|Functions]], it can be used _only_ in a [[:Text_Fields#Numeric_Fields|numeric calculation field]]. | ||
- | The first parameter may be: | + | ====== Usage ====== |
- | * 0: the main or action window. | + | - **`WINDOW(Coordinate)`** |
+ | - The `Index` is assumed to be the window of the Action in which the `WINDOW()` function is used (like the [Manipulate a Window](action:Manipulate a Window)), \\ OR, the frontmost window if the Action does not refer to a window. | ||
+ | - **`WINDOW(Index, Coordinate)`** | ||
+ | - With two parameters, the first parameter specifies which window in the front application to operate on. | ||
+ | |||
+ | |||
+ | ====== Parameters ====== | ||
+ | |||
+ | |||
+ | The first parameter, `Index`, which is optional, may be: | ||
+ | |||
+ | * 0: the frontmost window of the frontmost app. | ||
* Positive Number: the indexed window from front to back. | * Positive Number: the indexed window from front to back. | ||
* Negative Number: the indexed window from back to front. | * Negative Number: the indexed window from back to front. | ||
+ | * If this parameter is _not_ provided, then it is assumed to be the window of the Action in which the `WINDOW()` function is used, \\ OR, the frontmost window if the Action does not refer to a window. | ||
- | The second parameter specifies the desired *coordinate* and can be: | + | The second parameter, `Coordinate`, specifies the desired *coordinate* to be returned, and can be: |
* Left | * Left | ||
Line 18: | Line 31: | ||
* MidY | * MidY | ||
- | The WINDOW() function returns the desired coordinate of the specified window. | ||
===== See Also ===== | ===== See Also ===== |