ClickandDragLayout()

Summary

Allows the user to pan around a layout by dragging it to a new position.

 

Syntax

ClickAndDragLayout(string layout_name)

 

Argument	Contents
layout_name	The name of the layout to be changed

 

Notes

• ClickAndDragLayout is used to support the Pan tool (grabber hand) for layouts in the main toolbox.

• This function should be called only from a macro that is activated from the menus, or from a tool in a toolbox or toolbar. Calling it from any other type of dialog box often causes confusion about which window is active (the dialog box, versus the map).

Example

type = GetWindowType()

if type = "Layout" then do

     on escape do Return() end

     ClickAndDragLayout()

     DrawLayout()

     end

 

Error Codes

Error Type	Meaning
Escape	The user pressed Esc while dragging the layout
NotFound	The layout_name could not be found

 

See Also

Function	Summary
ClickDragAndShow()	Allows the user to pan a map by dragging it to a new position