mdlLocate_setFunction has been superceded by typesafe methods in LocateCallback. More...
Static Public Member Functions | |
| static LocateFunc_LocateFilter | SetPreLocateFunction (LocateFunc_LocateFilter newFunc) |
| Set up the locate function for all elements that are in the proximity of the test point, but before MicroStation applies the Search Criteria. More... | |
| static LocateFunc_LocateFilter | SetPostLocateFunction (LocateFunc_LocateFilter newFunc) |
| Set up the locate function for all elements that are in the proximity of the test point, after the element has already passed the Search Criteria. More... | |
| static MdlFunc_Accept | SetAcceptFunction (MdlFunc_Accept newFunc) |
| Set up the locate function for when the user accepts the highlighted element. More... | |
| static MdlFunc_Show | SetShowFunction (MdlFunc_Show newFunc) |
| Set up the locate function to show the result of a selection. More... | |
| static MdlFunc_Clean | SetCleanFunction (MdlFunc_Clean newFunc) |
| Set up the locate function to clean up the result of a selection. More... | |
| static MdlFunc_NotFound | SetNotFoundFunction (MdlFunc_NotFound newFunc) |
| Set up the locate function that is called whenever MicroStation attempts to Locate an element, but no acceptable elements were found. More... | |
| static LocateFunc_LocateFilter | SetGlobalPreLocateFunction (LocateFunc_LocateFilter newFunc) |
| This is the same as SetPreLocateFunction, except that this function is remains active regardless of the active command. More... | |
| static LocateFunc_LocateFilter | SetGlobalPostLocateFunction (LocateFunc_LocateFilter newFunc) |
| This is the same as SetPostLocateFunction, except that this function is remains active regardless of the active command. More... | |
| static Select_UserFunction | SetSelectCmdFunction (Select_UserFunction newFunc) |
| Set up the locate function that is called whenever MicroStation attempts to Locate an element, but no acceptable elements were found. More... | |
| static LocateFunc_OverridePathDescription | SetOverridePathDescriptionFunction (LocateFunc_OverridePathDescription newFunc) |
| Set up the locate function that is called to provide a description of a DisplayPathCP for the user. More... | |
| static LocateFunc_ElementDoubleClick | SetElementDoubleClickFunction (LocateFunc_ElementDoubleClick newFunc) |
| Set up the locate function to respond to double-click events on an element. More... | |
| static LocateFunc_ElementLocated | SetElementLocatedFunction (LocateFunc_ElementLocated newFunc) |
| Kept for compatability. More... | |
mdlLocate_setFunction has been superceded by typesafe methods in LocateCallback.
Use these methods to designate user functions to be called during MicroStation's element location process.
Whenever a primitive command is started, the locate user functions (with the exception of SetGlobalPostLocateFunction and SetSelectCmdFunction functions, see below) are cleared. Therefore, always call mdlState_startModifyCommand before calling LocateCallback methods.
The message that displays when the accept function is called is stored in the built-in variable locateAcceptPrompt. locateAcceptPrompt must be an index into a message list resource. The message list resource identifier must have been previously set by calling mdlState_registerStringIds. The promptStringId parameter is the resource identifier of the message list resource. It contains the prompt message, which is referenced by this index.