ApiCharacters

class ApiCharacters

Description

Class representing characters in an object that contains text.

Instance Methods

GetCount(): number

Returns a value that represents a number of objects in the collection.

GetParent(): ApiRange

Returns the parent object of the specified characters.

Delete()

Deletes the ApiCharacters object.

Insert(String)

Inserts a string replacing the specified characters.

SetCaption(Caption)

Sets a string value that represents the text of the specified range of characters.

GetCaption(): string

Returns a string value that represents the text of the specified range of characters.

SetText(Text)

Sets the text for the specified characters.

GetText(): string

Returns the text of the specified range of characters.

GetFont(): ApiFont

Returns the ApiFont object that represents the font of the specified characters.

Instance Properties

Countnumber

The number of characters in the collection.

ParentApiRange

The parent object of the specified characters.

Captionstring

The text of the specified range of characters.

Textstring

The string value representing the text of the specified range of characters.

FontApiFont

The font of the specified characters.

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).