Find

Find(What, After, LookIn, LookAt, SearchOrder, SearchDirection, MatchCase) → { ApiRange | null }

Finds specific information in the current range.

Parameters:

Name Type Description
What string | undefined

The data to search for.

After ApiRange

The cell after which you want the search to begin. If this argument is not specified, the search starts after the cell in the upper-left corner of the range.

LookIn XlFindLookIn

Search data type (formulas or values).

LookAt XlLookAt

Specifies whether the whole search text or any part of the search text is matched.

SearchOrder XlSearchOrder

Range search order - by rows or by columns.

SearchDirection XlSearchDirection

Range search direction - next match or previous match.

MatchCase boolean

Case sensitive or not. The default value is "false".

Returns:

Type
ApiRange | null

Example

Copy code
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
oWorksheet.GetRange("B1").SetValue(2014);
oWorksheet.GetRange("C1").SetValue(2015);
oWorksheet.GetRange("D1").SetValue(2016);
oWorksheet.GetRange("A2").SetValue("Projected Revenue");
oWorksheet.GetRange("A3").SetValue("Estimated Costs");
oWorksheet.GetRange("A4").SetValue("Cost price");
oWorksheet.GetRange("B2").SetValue(200);
oWorksheet.GetRange("B3").SetValue(250);
oWorksheet.GetRange("B4").SetValue(50);
oWorksheet.GetRange("C2").SetValue(200);
oWorksheet.GetRange("C3").SetValue(260);
oWorksheet.GetRange("C4").SetValue(120);
oWorksheet.GetRange("D2").SetValue(200);
oWorksheet.GetRange("D3").SetValue(200);
oWorksheet.GetRange("D4").SetValue(160);
var oRange = oWorksheet.GetRange("A2:D4");
var oSearchRange = oRange.Find("200", "B1", "xlValues", "xlWhole", "xlByColumns", "xlNext", true);
oSearchRange.SetFillColor(Api.CreateColorFromRGB(255, 213, 191));
builder.SaveFile("xlsx", "Find.xlsx");
builder.CloseFile();

Resulting document