View source for API:WindowSetDimensions

{{LuaApi|group=Window}}
Sets a window's width and height.

<pre>
WindowSetDimensions(windowName, width, height)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window.
;width, height : <code>number</code> – New size, before the window's scale is applied.

== Returns ==
Nothing.

== Details ==
* The size is in the window's own units. On screen it is multiplied by the window's scale ([[API:WindowGetScale|WindowGetScale]]).
* Negative values are stored as 0.
* For windows that are kept fully on screen (see [[API:WindowIsSticky|WindowIsSticky]]), the width and height are also limited to the screen size divided by the window's scale.
* If the size does not change, nothing else happens. Otherwise:
** For windows with state tracking enabled, <code>''windowName''.STATE.DIMENSION_X</code> and <code>DIMENSION_Y</code> are updated (see [[API:WindowGetDimensions|WindowGetDimensions]]).
** The client can call the window's <code>OnSizeUpdated</code> core event handler (see [[API:WindowRegisterCoreEventHandler|WindowRegisterCoreEventHandler]]) with the new width and height.
* Afterwards the window's own anchors are processed again. A window with two anchors on opposite corners therefore gets its size back from the anchors; clear or change the anchors to resize it.
* The root window cannot be resized.

== Errors ==
* <code>Error in function call 'WindowSetDimensions': Window %s does not exist</code>
* <code>Error in function call 'WindowSetDimensions': The dimensions of the root window cannot be changed.</code>
* <code>Error in function call 'WindowSetDimensions': Window %s is currently locked and may not be modified from lua. ...</code><br/>This check never triggers in the current client. See [[API:WindowSetShowing|WindowSetShowing]].

== Example ==
From <code>easystem_dialogmanager/source/dialogmanager.lua</code>:
<pre>
local x, y = WindowGetDimensions( "OneButtonDlg"..dlgIndex.."Box" )
WindowSetDimensions ( "OneButtonDlg"..dlgIndex, x, y )
</pre>

== See also ==
* [[API:WindowGetDimensions|WindowGetDimensions]]
* [[API:WindowResizeOnChildren|WindowResizeOnChildren]]
* [[API:WindowSetScale|WindowSetScale]]