MouseModeAPI.setSelectPointFeatureMode

 

void setSelectPointFeatureMode(string attrName, string attrValue, bool isSynchronous)

This method sets the state of the SDM such that a mouse down in any view displays the pick-aperture, a small box with cross-hairs, as the mouse cursor. The point feature (symbol) in the box, nearest the cross-hairs 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 attrValue (See Feature Selection Criteria).  If no feature in the pick-aperture satisfies this selection criterion, 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 getX and getY to obtain the location of the selected point feature (symbol).  If no feature was selected, getX and getY return the location of the mouse click.

The client using isSynchronous = FALSE, must have identified itself to the MouseModeAPI object (see Synchronous vs. Asynchronous Response) and exposed the method receiveLocation, to which the location’s (Exchange) coordinates and the index of the view in which the user clicked are provided via arguments.  If no feature was selected, the location is that of the mouse click; otherwise, it is that of the selected point feature (These two pairs of coordinates are typically not exactly the same).

The client can retrieve the unique identifier and other information about the selected feature.  (See Retrieving Selected-Feature Information).

This method returns 0 upon success, and returns an error code if attrName is invalid.

Migration note for v2.5 developers: setSelectPointFeatureMode corresponds to selectFeature or setSelectFeatCode, 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).