SetCaption
Sets a string value that represents the text of the specified range of characters.
Syntax
expression.SetCaption(Caption);
expression - A variable that represents a ApiCharacters class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| Caption | Required | string | A string value that represents the text of the specified range of characters. |
Returns
This method doesn't return any data.
Example
This example sets a string value that represents the text of the specified range of characters.
- Code
- Result
let worksheet = Api.GetActiveSheet();
let range = worksheet.GetRange("B1");
range.SetValue("This is just a sample text.");
let characters = range.GetCharacters(23, 4);
characters.SetCaption("string");