SelectByMapWindow()

Summary

Selects map features within the current map window.

 

Changes

Optional options array introduced in Version 5.0.

 

Syntax

n_selected = SelectByMapWindow(string set_name, string operation [, array options])

 

Argument	Contents
set_name	The name of the selection set
operation	The operation to perform, as indicated below:

 

Operation	Meaning
several	Replaces the contents of the selection set
less	Removes features from the selection set
more	Adds features to the selection set
subset	Selects a subset of the selection set

 

Option	Type	Contents
Inclusion	String	"Enclosed" or "Intersecting", overriding the current setting; for more information, seeSetSelectInclusion()
Max	Integer	Maximum number of records to select
Display	Boolean	"True" or "False" overriding the current setting; for more information, seeSetSelectDisplay()
Auto Redraw	Boolean	"True" or "False" overriding the current setting; for more information, seeSetSelectAutoRedraw()
Source And	String	A selection set on the current layer that records must be in to be selected
Source Not	String	A selection set on the current layer that records must not be in to be selected

 

Returns

An integer indicating the number of records in the selection set.

 

Notes

• The options array is an optional argument.

• All selection commands operate on the current layer.

• If the set does not already exist, SelectByMapWindow() creates it.

• Use SetSelectInclusion() to control whether features are selected only when fully contained in the search area, or when they intersect the search area.

Example

SelectByMapWindow("Features on the Map", "Several")

 

Error Codes

Error Type	Meaning
Error	The set name or the operation type is invalid; or there is no current map window
NotFound	No features were found inside the map window

 

See Also

Function	Summary
SelectByScope()	Selects the map features located within a scope
SetSelectInclusion()	Sets the inclusion status for spatial selection