SetSubscript
Sets the subscript property to the specified font. 💡 This method will work only with the text format of the cell.
Syntax
expression.SetSubscript(isSubscript);
expression - A variable that represents a ApiFont class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| isSubscript | Required | boolean | Specifies that the text characters are displayed subscript. |
Returns
This method doesn't return any data.
Example
This example sets the subscript property to the specified font.
- Code
- Result
// How to change a regular text to a subscript.
// Get a font object of characters and make it subscript.
const worksheet = Api.GetActiveSheet();
const range = worksheet.GetRange("B1");
range.SetValue("This is just a sample text.");
const characters = range.GetCharacters(9, 4);
const font = characters.GetFont();
font.SetSubscript(true);