Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RichTextInsertEvent<F>

Event emitted by CRichText when a range of characters (values) is inserted.

Type Parameters

  • F extends Record<string, any> = Record<string, any>

Hierarchy

Index

Properties

format: Partial<F>

The characters' format as inherited from existing spans.

This does not account for the format passed to CRichText.insert; changes to match that format will show up in later RichTextEventsRecord.Format events in the same transaction.

index: number

The index of the first affected character. Collectively, the characters have indices index through index + values.length - 1.

For TextEventsRecord.Delete events, this is the former index of the first deleted character.

Metadata for the update that caused this event.

positions: string[]

The positions corresponding to values.

values: string

The affected characters, concatenated into a single string.

Generated using TypeDoc