ClickShape()

Summary

Awaits user input from the system pointer and returns an array of coordinates that define a closed polygon.

Syntax

coord_array = ClickShape()

Returns

An array of coordinates that define a closed polygon.

Element Type Contents
1 Coord The first point of the polygon
...
n Coord The last point of the polygon

Notes

  • When used in a map window, ClickShape() returns coordinate values in longitude and latitude.

  • When used in a layout window, it returns coordinate values in the current page units (e.g., inches).

  • The polygon defined by the array of coordinates is explicitly closed; i.e., the last coordinate is guaranteed to be the same as the first.

  • 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).

Error Codes

Error Type Meaning
Escape The user clicked Cancel
NotFound A point or points fell outside the defined projection space (off the earth)

See Also

Function Summary
ClickPolyline() Awaits user input from the system pointer and returns an array of coordinates that define a line