Class: ExtendedSearchContext

Methods

getSearchField$El(fieldName){jQuery}

Returns the jQuery object of a search field's input field by its name.

Name	Type	Description
fieldName	String	the name of the field

• Since:

  • 5.0b

Returns:

Type	Description
jQuery	the jQuery object of the input field

getSearchFieldEl(fieldName){Element}

Returns the DOM element of a search field's input field by its name.

Name	Type	Description
fieldName	String	the name of the field

• Since:

  • 5.0b

Returns:

Type	Description
Element	the DOM element of the input field

getSearchFieldLabel$El(fieldName){jQuery}

Returns the jQuery object of a search field's label by its name.

Name	Type	Description
fieldName	String	the name of the field

• Since:

  • 5.0b

Returns:

Type	Description
jQuery	the jQuery object of the label

getSearchFieldNumberValue(fieldName, decimalSeparator, groupingSeparator){Number}

Gets the value of a search field as a Number. If the parameters decimalSeparator and
groupingSeparator are not set the method will use localized values.

Name	Type	Description
fieldName	String	the file field name
decimalSeparator	String	optional the decimal separator
groupingSeparator	String	optional the grouping separator

• Since:

  • 5.0b

Returns:

Type	Description
Number	the current value of the file field

Example

documentsContext.getExtendedSearchContext().getSearchFieldNumberValue("erpNetAmount", ".", ",");

getSearchFieldValue(fieldName){String}

Gets the value of a search field by its name.

Name	Type	Description
fieldName	String	the search field name

• Since:

  • 5.0b

Returns:

Type	Description
String	the current value of the search field

getSearchFieldValues(fieldNames){Object}

Gets the values for an array of search fields by their names.

Name	Type	Description
fieldNames	Array.<String>	the search field names

• Since:

  • 5.0b

Returns:

Type	Description
Object	the current values of the search fields

getSearchFormModel(){ExtendedSearchFormModel}

Returns the current search form model.
To modify the current search form before being displayed, it is recommended to use this function
combined with (while not limited to) the exit event ExtendedSearch.afterSetModelData.

• Since:

  • 5.0d

• See:

  • exitRegistry.registerSearchExitCallback

Returns:

Type	Description
ExtendedSearchFormModel	the extended search form model

getSearchFormView$El(){jQuery}

Returns the jQuery object of the entire search form view.

• Since:

  • 5.0b

Returns:

Type	Description
jQuery	the jQuery object of the search form view

getSearchFormViewEl(){Element}

Returns the DOM element of the entire search form view.

• Since:

  • 5.0b

Returns:

Type	Description
Element	the DOM element of the search form view

getSearchSourceNames(options)

Returns a shallow array of all currently available search source names.

Name	Type	Description
options	Object	optional Name Type Description filter Object optional a filter

• Since:

  • 5.0d

Example

var searchSourceNames = extSearchContext.getSearchSourceNames();

getSearchSources(options)

Returns a shallow array of all currently available search source items.
Each item contains (at least) the attributes id, name, type, label, selected and opened.

Name	Type	Description
options	Object	optional Name Type Description filter Object optional a filter

• Since:

  • 5.0d

Example

var searchSources = extSearchContext.getSearchSources();

getSelectedSearchSourceNames(options)

Returns a shallow array of all currently selected search source names.

Name	Type	Description
options	Object	optional Name Type Description filter Object optional a filter

• Since:

  • 5.0d

Example

var searchSourceNames = extSearchContext.getSelectedSearchSourceNames();

getSelectedSearchSources(options)

Returns a shallow array of all currently selected search source items.
Each item contains (at least) the attributes id, name, type, label, selected and opened.

Name	Type	Description
options	Object	optional Name Type Description filter Object optional a filter

• Since:

  • 5.0d

Example

var searchSources = extSearchContext.getSelectedSearchSources();

isSearchFieldVisible(fieldName){Boolean}

Checks if a search field is currently displayed or not.

Name	Type	Description
fieldName	String	the name of the field

• Since:

  • 5.0b

Returns:

Type	Description
Boolean	true if the field is visible, false otherwise

setSearchFieldBgColor(fieldName, color)

Sets the background-color of a search field by its name.

Name	Type	Description
fieldName	String	the name of the field
color	String	the new color

• Since:

  • 5.0b

Example

documentsContext.getExtendedSearchContext().setSearchFieldBgColor("erpInvoiceNumber", "#2F4F4F")

setSearchFieldBorderColor(fieldName, color)

Sets the border-color of a search field by its name.

Name	Type	Description
fieldName	String	the name of the field
color	String	the new color

• Since:

  • 5.0b

Example

documentsContext.getExtendedSearchContext().setSearchFieldBorderColor("erpInvoiceNumber", "#2F4F4F")

setSearchFieldColor(fieldName, color)

Sets the text-color of a search field by its name.

Name	Type	Description
fieldName	String	the name of the field
color	String	the new color

• Since:

  • 5.0b

Example

documentsContext.getExtendedSearchContext().setSearchFieldColor("erpInvoiceNumber", "#2F4F4F")

setSearchFieldFocus(fieldName)

Sets the focus to a search field by its name.

Name	Type	Description
fieldName	String	the name of the field

• Since:

  • 5.0b

setSearchFieldLabelColor(fieldName, color)

Sets the text-color of a search field label by its name.

Name	Type	Description
fieldName	String	the name of the field
color	String	the new color

• Since:

  • 5.0b

Example

documentsContext.getExtendedSearchContext().setSearchFieldLabelColor("erpInvoiceNumber", "#2F4F4F")

setSearchFieldOptions(fieldName, value, options)

Sets the options for a select menu.

Name	Type	Description
fieldName	String	the name of the select field
value	String | Array.<String> | Object	the values for the select field
options	Object	keepSelected === true: the previously selected value will be kept even if not inside the value String (default), false: the previously selected value will be removed except when inside the value String

• Since:

  • 5.0b

Example

Possible input for the value parameter
"value,value,..."
"key:value,key:value,..."
"key;locale:value;locale:value,key;locale:value;locale:value,..."
["value1","value2",...]
["key1;locale1:value;locale2:value", "key2;locale1:value;locale2:value", ...]
{"key1":"value1", "key2":"value2",...}
{"key1":{"locale1":"value";"locale2":"value"}, "key2":{"locale1":"value";"locale2":"value"}, ...}

setSearchFieldValue(fieldName, value){String}

Sets the value of a search field to the specified value by its name.

Name	Type	Description
fieldName	String	the search field name
value	String	the new value of the search field

• Since:

  • 5.0b

Returns:

Type	Description
String	the old value of the search field

setSearchFieldValues(fieldValues)

Sets the value of multiple search fields to the specified value by its name.

Name	Type	Description
fieldValues	Object

• Since:

  • 5.0b

Example

documentsContext.getExtendedSearchContext().setSearchFieldValues({"hrFirstName":"Matt","hrLastName":"Buchanan"})