Searching a table sheet

Searching a table sheet

Posted by: christina.devine on 1 March 2023, 8:46 am EST

• 

  christina.devine

  • Post Options:
  • Link
    Copy
  • Jump To Answer

  Posted 1 March 2023, 8:46 am EST

  hi Team,

  We are using table sheet for one of our requirements. Is it possible to search the data without making use of filtering ?

  We have search button outside of spread JS and we would like to perform search on table sheet using our own UI code.

• 

  avinash.pathak

  

  • Post Options:
  • Link
    Copy

  Posted 2 March 2023, 2:03 am EST

  Hello,

  You can search a value in a table sheet by getting the worksheet associated with tablesheet using tablesheet.getSheet() method.
  
  The worksheet has a method search() which can be utilized to search a value on the sheet. This method takes an object of GC.Spread.Sheets.Search.SearchCondition class as its argument and returns an object of GC.Spread.Search.SearchResult class. The SearchResult object provides information about the result of search including the position of found result in the sheet.
  
  Please refer to the code snippet and attached sample provided below for further understanding.
  
  let sheet = tableSheet.getSheet();
  
  let activeCol = sheet.getActiveColumnIndex();
  
  // creates a search condition
  
  var searchCondition = new GC.Spread.Sheets.Search.SearchCondition();
  
  searchCondition.searchString = searchString;
  
  searchCondition.startSheetIndex = spread.getActiveSheetIndex();
  
  searchCondition.endSheetIndex = spread.getActiveSheetIndex();
  
  searchCondition.columnStart = activeCol;
  
  searchCondition.columnEnd = activeCol;
  
  searchCondition.rowStart = 0;
  
  searchCondition.rowEnd = sheet.getRowCount() - 1;
  
  searchCondition.sheetArea = GC.Spread.Sheets.SheetArea.viewport;
  
  searchCondition.searchOrder = GC.Spread.Sheets.Search.SearchOrder.nOrder;
  
  searchCondition.searchTarget = GC.Spread.Sheets.Search.SearchFoundFlags.cellText;
  
  searchCondition.searchFlags = GC.Spread.Sheets.Search.SearchFlags.useWildCards;

  let searchResult = sheet.search(searchCondition);
  

  Sample: https://jscodemine.grapecity.com/share/4XQusePSb0_kLS6gox_HjA/?defaultOpen={“OpenedFileName”:[“/index.html”,“/app.js”],“ActiveFile”:“/app.js”}
  
  Please let us know if you still face any issue.
  
  doc reference

  searching docementation: https://www.grapecity.com/spreadjs/docs/features/workbook/searching#site_main_content-doc-content_title

  searching demo: https://www.grapecity.com/spreadjs/demos/features/cells/tags/tag-search#demo_source_name

  worksheet.search(): https://www.grapecity.com/spreadjs/api/v16/classes/GC.Spread.Sheets.Worksheet

  SearchCondition class: https://www.grapecity.com/spreadjs/api/v16/classes/GC.Spread.Sheets.Search.SearchCondition

  SearchResult class: https://www.grapecity.com/spreadjs/api/v16/classes/GC.Spread.Sheets.Search.SearchResult

  Regards,
  
  Avinash

• 

  christina.devine

  • Post Options:
  • Link
    Copy

  Posted 3 March 2023, 8:04 am EST

  Thanks Avinash. We will check and get back to you on this.
  
  Appreciate the quick response.

• 

  christina.devine

  • Post Options:
  • Link
    Copy

  Posted 6 March 2023, 12:15 pm EST

  Hi Avinash,

  The above code worked like a charm. I have one more question related to this. Is it possible to highlight search results in tablesheet ?

• 

  ankit.kumar

  

  • Post Options:
  • Link
    Copy

  Posted 7 March 2023, 1:37 pm EST

  Hello Christina,

  If you wish to draw attention to a search result in your spreadsheet, you can easily achieve this by applying a style to the cell that contains the result. To do so, you’ll need to create an instance of the GC.Spread.Sheet.Style() class and utilize the sheet.setStyle() method to apply it to the desired cell. Additionally, you can use the sheet.showCell() method to bring the cell with the search result into view.

  For a better understanding of how to implement this functionality, please refer to the attached sample provided at https://jscodemine.grapecity.com/share/hYHYVYZ4QU6CsTpoVIENPw/?defaultOpen={"OpenedFileName"%3A["%2Findex.html"%2C"%2Fapp.js"]%2C"ActiveFile"%3A"%2Fapp.js"}

  If you encounter any difficulties while attempting to implement this, please don’t hesitate to let us know.

  For additional information, please refer to the following documentation:

  GC.Spread.Sheets.Style class: https://www.grapecity.com/spreadjs/api/classes/GC.Spread.Sheets.Style
  
  sheet.setStyle(): https://www.grapecity.com/spreadjs/api/classes/GC.Spread.Sheets.Worksheet#setstyle
  
  sheet.showCell(): https://www.grapecity.com/spreadjs/api/classes/GC.Spread.Sheets.Worksheet#showcell

  Regards,

  Ankit