RIGHT
Returns the specified number of characters from the end of a text string.
Syntax
expression.RIGHT(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 that contains the characters to extract. | |
| arg2 | Optional | ApiRange | ApiName | number | A number of the substring characters. If it is omitted, the function will assume it to be 1. |
Returns
string
Example
This example shows how to the specified number of characters from the end of a text string.
- Code
- Result
// How to get characters from the end of a string.
// Use a function to return n characters from the right part of a text.
let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
worksheet.GetRange("A1").SetValue(func.RIGHT("Online Office", 2));