ClickRect()
Summary
Awaits user input from the system pointer and returns two coordinates that define a rectangle.
Syntax
corners_array = ClickRect(string ignored, real aspect_ratio)
| Argument | Contents |
|---|---|
| ignored | Must be null |
| aspect_ratio | The ratio of rectangle height to rectangle width. This aspect ratio is maintained when the user drags the rectangle |
Returns
An array of two coordinates, as follows:
| Element | Type | Contents |
|---|---|---|
| 1 | Coord | Location of the lower left corner of the rectangle |
| 2 | Coord | Location of the upper right corner of the rectangle |
Notes
-
If aspect_ratio is null, then the user can drag a rectangle of any shape.
-
When used in a map window, ClickRect() returns coordinate values in longitude and latitude.
-
When used in a layout window, ClickRect() returns coordinate values in the current page units (e.g., inches).
-
If the rectangle is so tiny as to likely be an inadvertent click instead of a drag, ClickRect() returns an array of two identical coordinates.
-
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 |
See Also
| Function | Summary |
|---|---|
| ClickEllipse() | Awaits user input from the system pointer and returns coordinates that define an ellipse |
| ClickCircle() | Awaits user input from the system pointer and returns a circle |