TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

GetCharacters

GetCharacters(Start, Length) → { ApiCharacters }

Returns the ApiCharacters object that represents a range of characters within the object text. Use the ApiCharacters object to format characters within a text string.

Parameters:

Name Type Description
Start number

The first character to be returned. If this argument is either 1 or omitted, this property returns a range of characters starting with the first character.

Length number

The number of characters to be returned. If this argument is omitted, this property returns the remainder of the string (everything after the Start character).

Returns:

Type
ApiCharacters

Example

Copy code
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oRange = oWorksheet.GetRange("B1");
oRange.SetValue("This is just a sample text.");
var oCharacters = oRange.GetCharacters(9, 4);
var oFont = oCharacters.GetFont();
oFont.SetBold(true);
builder.SaveFile("xlsx", "GetCharacters.xlsx");
builder.CloseFile();

Resulting document