API Frame SetClampedToScreen

From WoWWiki

This article or section is a World of Warcraft API stub. You can help expand it by editing it. Please see WoWWiki:How to edit API pages for a list of boilerplates and page tags to use for different types of API related pages.

Set whether the frame is prohibited from being positioned or dragged off screen. This applies to any attempt of repositioning a frame partially or entirely off screen. If the frame is clamped to the screen boundaries then the frame points will be re-adjusted automatically so that the entire frame always stays on screen. Examples where this applies:

• calling SetPoint()
• dragging the frame after calling StartMoving()
• sizing the frame after calling StartSizing()

Parameters

clamped 

Boolean - Whether to enable (true) or disable (false) the clamping of the frame to the screen boundaries

Returns

- unknown -

Example

The following sample code should cause the spell book frame to be places halfway outside the screen. Instead it stays fully inside of the screen.

SpellBookFrame:Show()
SpellBookFrame:SetClampedToScreen( true )
SpellBookFrame:SetPoint( "TOPLEFT", UIParent, "TOPLEFT", 1000, -100 )