TRY NEW VERSION

MATCH

MATCH(arg1, arg2, arg3) → { number | string | boolean }

Returns the relative position of an item in an array that matches a specified value in a specified order.

Parameters:

Name Type Description
arg1 any

Is the value you use to find the value you want in the array, a number, text, or logical value, or a reference to one of these.

arg2 number

Is a contiguous range of cells containing possible lookup values, an array of values, or a reference to an array.

arg3 number

Is a number 1, 0, or -1 indicating which value to return..

Returns:

Type
number | string | boolean

Example

Copy code
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oFunction = Api.GetWorksheetFunction();
var ids = ["ID", 1, 2, 3, 4, 5];
var clients = ["Client", "John Smith", "Ella Tompson", "Mary Shinoda", "Lily-Ann Bates", "Clara Ray"];
var phones = ["Phone number", "12054097166", "13343943678", "12568542099", "12057032298", "12052914781"];

for (var i = 0; i < ids.length; i++) {
    oWorksheet.GetRange("A" + (i + 1)).SetValue(ids[i]);
}
for (var j = 0; j < clients.length; j++) {
    oWorksheet.GetRange("B" + (j + 1)).SetValue(clients[j]);
}
for (var n = 0; n < phones.length; n++) {
    oWorksheet.GetRange("C" + (n + 1)).SetValue(phones[n]);
}

var oRange = oWorksheet.GetRange("B1:B5");
oWorksheet.GetRange("D6").SetValue(oFunction.MATCH("Ella Tompson", oRange, 0));
builder.SaveFile("xlsx", "MATCH.xlsx");
builder.CloseFile();

Resulting document