Searching in EJ2 TypeScript Spreadsheet control

13 Dec 20246 minutes to read

Find and Replace helps you to search for the target text and replace the found text with alternative text within the sheet or workbook. You can use the allowFindAndReplace property to enable or disable the Find and Replace functionality.

  • The default value for allowFindAndReplace property is true.

Find

Find feature is used to select the matched contents of a cell within the sheet or workbook. It is extremely useful when working with large set of data source.

User Interface:

Find can be done by any of the following ways:

  • Select the Search icon in the Ribbon toolbar or use Ctrl + F key to open the Find dialog.
  • Use find Next and find Previous buttons to search the given value in the workbook.
  • Select the option button in Find dialog to open the Find and Replace dialog. Then, select the below properties for enhanced searching.
  • Search within: To search the target in a sheet (default) or in an entire workbook.
  • Search by: It enhance the search, either By Rows (default), or By Columns.
  • Match case: To find the matched value with case sensitive.
  • Match exact cell contents: To find the exact matched cell value with entire match cases.
  • Using find() method to perform find operation.

Replace

Replace feature is used to change the find contents of a cell within sheet or workbook. Replace All is used to change all the matched contents of a cell within sheet or workbook.

User Interface:

Replace can be done by any of the following ways:

  • Use Ctrl + H key to open the Find and Replace dialog.
  • Use Replace button to change the found value in sheet or workbook.
  • Using Replace All button, all the matched criteria can be replaced with find value based on sheet or workbook.
  • Using replace() method to perform replace operation by passing the argument args.replaceby as replace.
  • Using replace() method to perform replace all operation by passing the argument args.replaceby as replaceall.

Go to

Go to feature is used to navigate to a specific cell address in the sheet or workbook.

User Interface:

  • Use Ctrl + G key to open the Go To dialog.
  • Use goTo() method to perform Go To operation.

In the following sample, searching can be done by following ways:

  • Select the Home tab in the Ribbon toolbar, and then select the Search icon.
  • Enter any value in the search textbox.
  • Select the next (or) previous button to find the entered value in the spreadsheet.
  • You can have more options to find values by selecting the more options in the search toolbar.
import { Spreadsheet, ColumnModel } from '@syncfusion/ej2-spreadsheet';
import { defaultData, budgetData} from './datasource.ts';

let columns: ColumnModel[] = [
    {
        width: 130
    },
    {
        width: 92
    },
    {
        width: 96
    }
];

let spreadsheet: Spreadsheet = new Spreadsheet({
    sheets: [{ name: 'Price Details', ranges: [{ dataSource: defaultData }], columns: columns },
    { name: 'Budget', ranges: [{ dataSource: budgetData }], columns: columns }],
    allowFindAndReplace: true
});

//Render the initialized Spreadsheet
spreadsheet.appendTo('#spreadsheet');
<!DOCTYPE html>
<html lang="en">

<head>
        <title>EJ2 SpreadSheet</title>
        <meta charset="utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
        <meta name="description" content="Typescript UI Controls" />
        <meta name="author" content="Syncfusion" />
        <link rel="shortcut icon" href="resources/favicon.ico" />
        <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
        <link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-base/styles/material.css" rel="stylesheet" />
        <link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-inputs/styles/material.css" rel="stylesheet" />
        <link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-buttons/styles/material.css" rel="stylesheet" />
        <link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-splitbuttons/styles/material.css" rel="stylesheet" />
        <link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-lists/styles/material.css" rel="stylesheet" />
        <link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-navigations/styles/material.css" rel="stylesheet" />
        <link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
        <link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-dropdowns/styles/material.css" rel="stylesheet" />
        <link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-grids/styles/material.css" rel="stylesheet" />
        <link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-spreadsheet/styles/material.css" rel="stylesheet" />
        <link href="styles.css" rel="stylesheet" />
        <script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/core-js/2.4.1/shim.min.js"></script>
        <script src="system.config.js"></script>
        <script src="es5-datasource.js" type="text/javascript"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>

<body>
        <!--Element which is going to render-->
        <div id='loader'>Loading....</div>
       <div id='container'>
       <div id="spreadsheet"></div>
       </div>
</body>

</html>

Limitations

  • Undo/redo for Replace All is not supported in this feature.