LEFT
Returns the specified number of characters from the start of a text string.
Syntax
expression.LEFT(arg1, arg2);
expression - A variable that represents a ApiWorksheetFunction class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| arg1 | Required | ApiRange | ApiName | string | The text string containing the characters to extract. | |
| arg2 | Optional | ApiRange | ApiName | number | A number of the substring characters. It must be greater than or equal to 0. |
Returns
string
Example
This example shows how to return the specified number of characters from the start of a text string.
- Code
- Result
// How to find the number of characters starting from the index.
// Use a function to get a length of a text starting from the index.
let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
worksheet.GetRange("A1").SetValue(func.LEFT("Online Office", 6));