ClickRectScope()
Summary
Awaits user input from the system pointer, accepts a rectangle whose center is a valid world point, and returns a scope.
Syntax
scope = ClickRectScope()
Returns
The scope calculated from the indicated rectangle.
Notes
-
Click RectScope() is similar to ClickScope(), but requires that the center of the user-indicated rectangle be a valid world point (on the earth). Click RectScope() is more appropriate than ClickScope() to get input for the location of a rectangle annotation.
-
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).
-
For a full list of scope-related GISDK functions, see Map Scales and Scopes.
Error Codes
| Error Type | Meaning |
|---|---|
| Escape | The user clicked Cancel |
| NotFound | The input rectangle center is not a valid world point |
See Also
| Function | Summary |
|---|---|
| ClickEllipseScope() | Awaits user input from the system pointer, accepts an ellipse, and returns a scope |
| ClickScope() | Awaits user input from the system pointer, accepts a rectangle, and returns a scope |