Class: QuickSearch

Cadcorp.UI.QuickSearch

new QuickSearch(config)

Displays the quick search
Parameters:
Name Type Description
config Object Configuration for this object. The config supplied directly extends the control

Members

clearButtonImage

Properties:
Name Type Description
clearButtonImage string The url to use for the image for the clear button

closeButtonImageUrl

Properties:
Name Type Description
closeButtonImageUrl string The url to the close button for the simple results

controlPrefix

Properties:
Name Type Description
controlPrefix string The asp.net client id

delay

Properties:
Name Type Description
delay number The delay, in milliseconds, between a key being pressed and a search being performed

dialogControllerID

Properties:
Name Type Description
dialogControllerID string The id of the dialog controller.

dialogTitle

Properties:
Name Type Description
dialogTitle string The title for the results dialog

errorText

Properties:
Name Type Description
nothingFoundText string The text to display in the event of an error

extraResultsToFetch

Properties:
Name Type Description
extraResultsToFetch number The amount results to fetch each time the more data button is clicked

footerid

Properties:
Name Type Attributes Description
footerid string <nullable>
 The id of the footer element

id

Properties:
Name Type Description
id string The unique id of this quick search

initialAmountOfResultsToFetch

Properties:
Name Type Description
initialAmountOfResultsToFetch number The amount of results to fetch the first time a search is performed

initialText

Properties:
Name Type Description
initialText string The intial text to display in the textbox

loadingImageUrl

Properties:
Name Type Description
loadingImageUrl string The url to the loading image
Properties:
Name Type Attributes Description
menuId string <nullable>
 The id of the menu control

minCharsBeforeSearch

Properties:
Name Type Description
minCharsBeforeSearch number The minimum number of characters that must be input into the textbox element before a search will be performed

moreDataText

Properties:
Name Type Description
moreDataText string The text to display if more data is available

nothingFoundText

Properties:
Name Type Description
nothingFoundText string The text to display if no results are found

resultClearEventHandler

Properties:
Name Type Description
resultClearEventHandler Cadcorp.UI.QuickSearch~resultsClearedCallback Callback used when the clear results button is clicked

resultDialogHeightFactor

Properties:
Name Type Attributes Description
resultDialogHeightFactor number <nullable>
 The height factor of the results dialog

resultSelectedEventHandler

Properties:
Name Type Description
resultSelectedEventHandler Cadcorp.UI.QuickSearch~resultSelectedCallback Callback used when a result is selected

searches

Properties:
Name Type Description
searches Array.<Cadcorp.UI.QuickSearch.SearchConfig> Configuration objects for the searches

searchingText

Properties:
Name Type Description
searchingText string The text to display while a search is performed

serviceUrl

Properties:
Name Type Description
serviceUrl string The url to the search webservice

usejQueryUI

Properties:
Name Type Description
usejQueryUI boolean True to use jQuery UI otherwise false

usejQueryUI

Properties:
Name Type Description
usejQueryUI boolean True to use jQuery UI otherwise false

Methods

(protected) clearClickHandler(eventArgs)

Event handler for clear button click
Parameters:
Name Type Description
eventArgs Object jQuery event object

(protected) resultSelected(eventArgs)

Event handler for rowselected. Calls this.resultSelectedEventHandler
Parameters:
Name Type Description
eventArgs Object

Type Definitions

resultSelectedParameter

resultSelectedCallback parameter
Type:
  • Object
Properties:
Name Type Attributes Description
zoomResolution number <nullable>
 The resolution to zoom to, either the zoomResolution or zoomScale must be non null
zoomScale number <nullable>
 The scale to zoom to, either the zoomResolution or zoomScale must be non null
X number The x coordinate for this result
Y number The y coordinate for this result
epsgCode number <nullable>
 The EPSG code
icon Cadcorp.Icon The icon to display when a result of this search is selected
address string The result text to display

SearchConfig

Configuration for a search
Type:
  • Object
Properties:
Name Type Description
name string The name of this search
icon Cadcorp.Icon The icon to display when a result of this search is selected
resultColumn string The property in the results that contains the text to display
eastingColumn string The property in the results that contains the easting value
northingColumn string The property in the results that contains the northing value

resultsClearedCallback()

Callback for result clear

resultSelectedCallback(eventArg)

Callback for result selected
Parameters:
Name Type Description
eventArg Cadcorp.UI.QuickSearch.resultSelectedParameter