Skip to main content

ITextHandler

Interfaces

ITextHandler

Handler for performing simple operations with text content.

Properties

textChangeEvent
textChangeEvent: EventObject<void>;

Text content change event.

Methods

deleteAllText()
deleteAllText(): IPositionInText;

Deletes all text.

Returns

IPositionInText

deleteTextByRange()
deleteTextByRange(textRange): IPositionInText;

Deletes text by range

Parameters
ParameterTypeDescription
textRangeITextRangetext range.
Returns

IPositionInText

deleteTextToDirection()
deleteTextToDirection(direction): IPositionInText;

Deletes the selected text or character relative to the current cursor position.

Parameters
ParameterTypeDescription
directionMoveDirectionTypedirection of text deletion.
Returns

IPositionInText

getAllText()
getAllText(): ITextRange;

Returns all text.

Returns

ITextRange

getFormattedText()
getFormattedText(): string;

Returns formatted text.

Returns

string

getParagraphCount()
getParagraphCount(): number;

Returns paragraph count.

Returns

number

getParagraphText()
getParagraphText(paragraphIndex): ITextRange;

Returns the text range of a paragraph by index.

Parameters
ParameterTypeDescription
paragraphIndexanyparagraph index (from 0).
Returns

ITextRange

getTextModel()
getTextModel(): Text;

Returns the text model.

Returns

Text

getTextRangeByPositions()
getTextRangeByPositions(startPosition, endPosition): ITextRange;

Returns the range of text by starting and ending position.

Parameters
ParameterTypeDescription
startPositionIPositionInTextstarting position.
endPositionIPositionInTextending position.
Returns

ITextRange

insertFormattedText()
insertFormattedText(text): void;

Inserts formatted text relative to the current cursor position.

Parameters
ParameterTypeDescription
textstringtext to insert.
Returns

void

insertNewLine()
insertNewLine(): void;

Inserts a new line relative to the current cursor position.

Returns

void

insertPlainText()
insertPlainText(text): void;

Inserts plain text relative to the current cursor position.

Parameters
ParameterTypeDescription
textstringtext to insert.
Returns

void

setTextFrames()
setTextFrames(data, isMeasureFrame): void;

Sets the frame of text.

Parameters
ParameterTypeDescription
dataITextFrameDatatext frame data.
isMeasureFramebooleanindicates if the frame is needed for further measurement.
Returns

void

setTextModel()
setTextModel(model): void;

Sets the text model.

Parameters
ParameterTypeDescription
modelTexttext model.
Returns

void

setWrappingPath()
setWrappingPath(data): void;

Sets the wrapping path.

Parameters
ParameterTypeDescription
dataIWrappingPathDatawrapping path data.
Returns

void

Was this page helpful?