Sign in

Enabling xClass Search for Custom Search Mode

March 9, 2026 07:09 AM
1 min read

It is necessary to set “supportXClassSearch” flag in the constructor of a custom search mode.

SearchMode:

JavaScript

function MyCustomSearch(searchContainer) {

    // This flag enables the possibility to use xClass Search with this SearchMode
                                            

    this.supportXClassSearch = true;
                                            

 

    // MyCustomSearch initialization code
                                            

    // Call base SearchMode constructor
                                            

    SearchMode.prototype.constructor.call(this, searchContainer, aras);
                                            

}

 

MyCustomSearch.prototype = new SearchMode;

// MyCustomSearch implementation

Note
If the xClass Search criteria is not compatible with the custom search mode a validation message appears every time you try to build a query using xClass criteria.