Skip to main content

Search Sheet

Searches for a term in a sheet and returns a list of cell addresses where the term was found.

Common Properties

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing the node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If ContinueOnError property is true, no error is caught when the project is executed even if the Catch node is used.

Input

  • File Descriptor - File descriptor of the Excel file. This is the identifier returned by the Open Excel node.
  • Search Term - Text or value to search for in the sheet.

Output

  • Found Cells - List of cell addresses where the search term was found (e.g., ["A1", "C5", "E10"]).

Options

  • Sheet Selection - Whether to search in the active sheet or a specific sheet:
    • Active-Sheet - Search in the currently active sheet
    • Specific-Sheet - Search in a specific sheet (requires Sheet Name)
  • Sheet Name - Name of the specific sheet to search. Required when Sheet Selection is "Specific-Sheet".

Example

Searching in the active sheet:

// File Descriptor: message.excel_fd
// Search Term: "Invoice"
// Sheet Selection: Active-Sheet
// Output: ["A5", "B12", "D20"]

Searching in a specific sheet:

// Search Term: "Total"
// Sheet Selection: Specific-Sheet
// Sheet Name: "Summary"
// Searches only in the Summary sheet

Finding product codes:

// Search Term: "PRD-001"
// Returns all cells containing this product code

Processing search results:

// After Search Sheet:
// For Each with message.cells
// - Read cell value at message.item
// - Perform action based on location

Case-insensitive search:

// Search Term: "error"
// Finds "Error", "ERROR", "error", etc.

Tips

  • The search is case-insensitive by default.
  • The search looks for partial matches (e.g., searching "cat" will find "catalog").
  • Cell addresses are returned without dollar signs (e.g., "A1", not "$A$1").
  • The search covers only the used range of the sheet.
  • If no matches are found, an error is thrown (use Continue On Error to handle this).
  • Search is performed row by row from left to right, top to bottom.

Common Errors

ErrorSolution
Search Term cannot be emptyProvide a search term
Sheet Name cannot be empty when Specific Sheet is selectedProvide a sheet name
Sheet does not exist in the workbookVerify the sheet name is correct
Could not find any matchesNo cells contain the search term (use Continue On Error to handle)
Invalid File DescriptorEnsure the Open Excel node was executed first