Search Text

GET /api/spreadsheet/getcellvalue?id&filename&extension&text&sheetindex&sheetname&startrowindex&startcolumnindex&endrowindex&endcolumnindex&range&matchentirecellcontents&matchcase

Description: Searches the worksheet for specified text. The returned response is a collection of cells that matches the search term.

Parameters

  • id - an identifier of a session to which the document has been loaded. This parameter's value is returned by the request used to create or load the document.
  • filename - a string value that specifies the file name of the document.
  • extension - a string value that specifies the file extension of the document. The supported file extensions are: OPENXML (XLSX), XLS and CSV.
  • sheetindex - a zero-based index of the worksheet that contains the searched text.
  • sheetname - a name of the worksheet that contains the searched text.
  • startrowindex - a zero-based index of the first row that binds the area used for the search.
  • startcolumnindex - a zero-based index of the first column that binds the area used for the search.
  • endrowindex - a zero-based index of the last row that binds the area used for the search.
  • endcolumnindex - a zero-based index of the last column that binds the area used for the search.
  • range - an object specifying a cell range used for the search.
  • matchentirecellcontents - a boolean value. True to restrict the search to the entire cell content; otherwise, false.
  • matchcase - a boolean value. True to perform a case-sensitive search; otherwise, false.