long
setSelectFeatureCollectionMode(int type, string attrName, string
attrValue,
This method sets the state of the SDM such that the user can click and drag a rectangle of any size. Each feature that is contained within the rectangle when the mouse button is released is selected, i.e. it is put into the Selection List,, if its attribute as named in attrName has the value given in attrVal (including possible wild cards) and the type of feature matches that given by type. (See Feature Selection Criteria). If no feature in the rectangle satisfies this selection criteria, no feature is selected.
The
client using isSynchronous = TRUE must test for completion of the
operation (See Synchronous vs.
Asynchronous Response).
When isSynchronousOpComplete
returns TRUE, the client must call getRespondingViewIndex
to determine the index of the view in which the user clicked.
The
client using isSynchronous = FALSE, must have identified itself to the
MouseModeAPI object (see Synchronous vs.
Asynchronous Response)
and exposed the method receiveSelectionViewIndex,
to which the responding view index is provided via argument.
The client can retrieve the unique identifier and other information about the selected features. (See Retrieving Selected-Feature Information).
This method returns 0 upon
success, and returns an error code if either type or attrName is
invalid.
Migration note for v2.5 developers: setSelectFeatureCollectionMode corresponds to selectFeatureCollection or setSelectFeatureCollection, when used synchronously or asynchronously, respectively, with attrName = “Feature Code” and attrValue set to a specific feature code or partial feature code with wild card(s).