DropAnnotations()
Summary
Removes annotations from a map or layout window.
Syntax
DropAnnotations(string window_spec, array ids)
| Argument | Contents |
|---|---|
| window_spec | String containing the window type and name |
| id | Array of IDs of the annotation to be dropped |
Notes
-
If any of the IDs are null, or an annotation with one of the IDs does not exist, DropAnnotations() drops all valid annotations and returns without an error.
-
For a full list of GISDK functions for annotations, see Freehand Items (Annotations).
Example
DropAnnotations("Map|My First Map", {1, 14, 27})Error Codes
| Error Type | Meaning |
|---|---|
| NotFound | The map or layout window does not exist. |
See Also
| Function | Summary |
|---|---|
| AddAnnotation() | Adds an annotation to a map or layout window |
| DropAnnotation() | Removes an annotation from a map or layout window |
| DuplicateAnnotation() | Creates a copy of an annotation |
| GetAnnotation() | Returns the definition of an annotation |
| GetAnnotations() | Return the IDs of all annotations in a map or layout window |
| MoveAnnotation() | Moves an annotation to a new location |
| SetAnnotation() | Modifies an existing annotation in a map or layout window |