# DataType:window This contains data related to the specified in-game window Windows come in many forms, but all are represented with the generic **window** type. In some of the descriptions, a **bold** window type may be specified, which defines the behavior for that type of window. ## Members | **Type** | **Member** | **Description** | | -------------------------------------------------------------------------------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [*argb*](/macroquest/data-types-and-top-level-objects/data-types/datatype-argb.md) | **BGColor** | Background color | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Checked** | Returns TRUE if the button has been checked | | [*window*](/macroquest/data-types-and-top-level-objects/data-types/datatype-window.md) | **Child\[** *name* **]** | Find a child window with the provided name | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Children** | Returns TRUE if the window has children | | [*window*](/macroquest/data-types-and-top-level-objects/data-types/datatype-window.md) | **CurrentTab** | **TabBox:** Returns the **Page** window associated with the currently selected tab. | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **CurrentTabIndex** | **TabBox**: Returns the index of the currently selected tab. | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Enabled** | Returns TRUE if the window is enabled | | [*window*](/macroquest/data-types-and-top-level-objects/data-types/datatype-window.md) | **FirstChild** | First child window | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **GetCurSel** | Index of the currently selected/highlighted item in a list or treeview | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **Height** | Height in pixels | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Highlighted** | Returns TRUE if the window is highlighted | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **HisTradeReady** | Has the other person clicked the Trade button? | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **HScrollMax** | Horizontal scrollbar range | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **HScrollPos** | Horizontal scrollbar position | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **HScrollPct** | Horizontal scrollbar position in % to range from 0 to 100 | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **Items** | Number of items in a Listbox or Combobox | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **List\[** #**,** y **]** | Get the text for the `#`th item in a list box. Only works on list boxes. Use of `y` is optional and allows selection of the column of the window to get text from. | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **List\[** text**,** y **]** | Find an item in a list box by partial match (use **window\.List\[**=text**]** for exact). Only works on list boxes. Use of `y` is optional and allows selection of the column of the window to search in. | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Minimized** | Returns TRUE if the window is minimized | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **MouseOver** | Returns TRUE if the mouse is currently over the window | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **MyTradeReady** | Have I clicked the Trade button? | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **Name** |

Name of window piece, e.g. "ChatWindow" for top level windows, or the piece name for child windows.

Note: this is Custom UI dependent

| | [*window*](/macroquest/data-types-and-top-level-objects/data-types/datatype-window.md) | **Next** | Next sibling window | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Open** | Returns TRUE if the window is open | | [*window*](/macroquest/data-types-and-top-level-objects/data-types/datatype-window.md) | **Parent** | Parent window | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **ScreenID** |

ScreenID of window piece.

Note: This is not Custom UI dependent, it must be the same on all UIs

| | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Siblings** | Returns TRUE if the window has siblings | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **Style** | Window style code | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **TabCount** | **TabBox:** The number of tabs present in the TabBox. | | [*window*](/macroquest/data-types-and-top-level-objects/data-types/datatype-window.md) | **Tab\[** # or Name **]** | **TabBox:** Looks up the **Page** window that matches the provided index or tab text. | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **Text** |

Window's text.

STMLBox: returns the contents of the STML.

Page: returns the name of the page's Tab.

| | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **Tooltip** | TooltipReference text | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **Type** | Type of window piece (Screen for top level windows, or Listbox, Button, Gauge, Label, Editbox, Slider, etc) | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **VScrollMax** | Vertical scrollbar range | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **VScrollPct** | Vertical scrollbar position in % to range from 0 to 100 | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **VScrollPos** | Vertical scrollbar position | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **Width** | Width in pixels | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **X** | Screen X position | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **Y** | Screen Y position | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **To String** | TRUE if window exists, FALSE if not | ## Methods | **Name** | Action | | ----------------------------------- | ------------------------------------------------------------------- | | **DoClose** | Does the action of closing a window | | **DoOpen** | Does the action of opening a window | | **LeftMouseDown** | Does the action of clicking the left mouse button down | | **LeftMouseHeld** | Does the action of holding the left mouse button | | **LeftMouseHeldUp** | does the action of holding the left mouse button up | | **LeftMouseUp** | Does the action of clicking the left mouse button up | | **RightMouseDown** | does the action of clicking the right mouse button | | **RightMouseHeld** | Does the action of holding the right mouse button | | **RightMouseHeldUp** | Does the action of holding the right mouse button up | | **RightMouseUp** | Does the action of clicking the right mouse button up | | **Select** | Selects the specified window | | **SetCurrentTab\[** # or Name **]** | If the window is a TabBox, set the current tab by index or by name. | ## Examples `/invoke ${Window[MerchantWnd].DoOpen}` Expected Result: the Merchant window window appears `/echo ${Window[MerchantWnd].Open}` Returns TRUE if a Merchant window is open `/echo ${Window[windowname]}` Returns TRUE if the WindowName exists, but doesn't have to be opened. `/echo ${Window[MerchantWnd].Minimized}` Returns TRUE if the Window is opened and minimized `/echo ${Window[MerchantWnd/ItemList].List[=Water Flask,2]}` Returns the index (int) of Water Flask in the merchant's item list. ",2" means scan the second column, since that's where the item names are. `${Window[TradeskillWnd/RecipeList].List[=Inky Shadow Silk]}` Find an item in the tradeskill item list box by the exact name Inky Shadow Silk `${Window[TradeskillWnd/RecipeList].List[1]}` Get the first-column text for the 1st item in the tradeskill item list box `${Window[tradewnd].HisTradeReady}` Return TRUE if the other person has clicked the Trade button in the Trade Window `${Window[tradewnd].MyTradeReady}` Return TRUE if I have clicked the Trade button in the Trade Window (TradeWnd) `${Window[RewardSelectionWnd/RewardPageTabWindow].Tab[Brew for the Day].Child[RewardSelectionOptionList].List[2]}` Returns the name of the 2nd option in the list of rewards for the tab titled "Brew for the Day" > Overseer Tetradrachm --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://macroquest.gitbook.io/macroquest/data-types-and-top-level-objects/data-types/datatype-window.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.