Class: NoticeBoardEmbeddedQuickSearch

Cadcorp.UI.NoticeBoard.NoticeBoardEmbeddedQuickSearch

new NoticeBoardEmbeddedQuickSearch(config)

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

Extends

Members

clearButtonImage

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

closeButtonImageUrl

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

containerID

Properties:
Name Type Description
containerID string The id of the container element for this emebdded search

controlPrefix

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

delay

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

dialogControllerID

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

dialogTitle

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

errorDialogTitleText

Properties:
Name Type Description
errorDialogTitleText string The text to display in the title of the error dialog
Inherited From:

errorText

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

extraResultsToFetch

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

footerid

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

geolocateCurrentText

Properties:
Name Type Description
geolocateCurrentText string The text to display in the current location when the user clicks the geolcate button
Inherited From:

geolocateFailedText

Properties:
Name Type Description
geolocateFailedText string The text to display if geolocation fails
Inherited From:

geolocateImageAltText

Properties:
Name Type Description
geolocateImageAltText string The alt text geolocate button

geolocateImageURL

Properties:
Name Type Description
geolocateImageURL string The url to the image for the geolocate button

geolocateTooltipText

Properties:
Name Type Description
geolocateTooltipText string The tooltip text for the geolcate button
Inherited From:

geolocateUncapableText

Properties:
Name Type Description
geolocateUncapableText string The text to display if geolocation API id unavailable
Inherited From:

id

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

initialAmountOfResultsToFetch

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

initialText

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

loadingImageUrl

Properties:
Name Type Description
loadingImageUrl string The url to the loading image
Inherited From:

(protected) m_errorDialog

Properties:
Name Type Description
m_errorDialog Cadcorp.UI.ErrorDialog The jquery dialog used to display any error for this dialog
Inherited From:
Properties:
Name Type Attributes Description
menuId string <nullable>
 The id of the menu control
Inherited From:

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
Inherited From:

moreDataText

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

nothingFoundText

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

resultClearEventHandler

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

resultDialogHeightFactor

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

resultSelectedEventHandler

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

searches

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

searchingText

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

serviceUrl

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

showGeolocation

Properties:
Name Type Description
showGeolocation boolean True to show the geolocation button, otherwise false

usejQueryUI

Properties:
Name Type Description
usejQueryUI boolean Should jQueryUI be used for UI elements
Inherited From:

Methods

(protected) clearClickHandler(eventArgs)

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

(protected) createQuickSearchStructure(The)

Creates the dom structure for the quick search control
Parameters:
Name Type Description
The object configuration object supplied to the constructor

(protected) resultSelected(eventArgs)

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