GetSelectedAnnotations()

Summary

Gets the IDs of selected annotations in a map or layout window.

 

Syntax

list = GetSelectedAnnotations(string window_spec)

 

Argument	Contents
window_spec	Window type and name

 

Returns

An array of integer IDs of the selected annotations, or null if no annotations are selected.

 

Notes

• For a full list of GISDK functions for annotations, see Freehand Items (Annotations).

Example

anns = GetSelectedAnnotations("Map|My Map")

for i = 1 to anns.length do CopyAnnotation("Map|My Map", anns[i]) end

 

Error Codes

Error Type	Meaning
NotFound	The map or layout window does not exist.

 

See Also

Function	Summary
DropSelectedAnnotations()	Removes the selected annotations from a map or layout window
GetAnnotation()	Gets the definition of an annotation
GetAnnotations()	Returns the IDs of all annotations in a map or layout window
SelectAnnotation()	Adds an annotation to the list of selected annotations
SelectAllAnnotations()	Selects all annotations in a map or layout window