Event types related to fields. Used for registering to events. See Register for more information. Those events will hold optionally also a field in the callback for reference.

Enumeration Members

AfterFieldAdd: "Field.Add"

Called when a field has been added to the document.

  • event data: null
  • cannot be cancelled
  • field object holds the newly added field.
AfterFieldDelete: "Field.Delete"

Called after a field has been deleted from the editor.

  • event data: null
  • cannot be cancelled
  • field object holds the field which has been deleted.
BeforeFieldAdd: "Before.Field.Add"

Called before a field is being added to the editor via the UI.

BeforeFieldDelete: "Before.Field.Delete"

Called before a field is being deleted from the editor.

  • event data: null
  • can be cancelled
  • field object holds the field which should be deleted.
BeforeFieldInsert: "Before.Field.Insert"

Called before the field is inserted to the editor. Used only when pasting fields.

  • event data: null
  • can be cancelled
  • field object holds the field which should be inserted. Note that the field does not exist and is just the copy of the field which will be inserted.
BeforeFieldZIndex: "Before.Field.ZIndex"

Called before a field is rearranged (z-index changed).

BeforeFieldZIndexPage: "Before.Field.ZIndex.Page"

Called before fields are rearranged on a page

FieldImageChanged: "Field.ImageChanged"

Called when the image has been changed on an ImageField.

  • event data: null
  • cannot be cancelled
  • field object holds the field which has been changed.
FieldMoveAndSize: "Field.MoveAndSize"

Called when a field has been repositioned and/or resized.

  • event data: null
  • cannot be cancelled
  • field object holds the field which has been changed.
FieldSelectionChanged: "Editor.Selection"

Called when the editor selection changes.

  • event data: null
  • cannot be cancelled
  • field object holds the selected field(s). If nothing is selected, the array will be empty.
FieldTextResorted: "Field.TextResorted"

Called when text within a text field has been resorted.

FieldZIndex: "Field.ZIndex"

Called after a field is rearranged (z-index changed).

FieldZIndexPage: "Field.ZIndex.Page"

Called after fields are rearranged on a page

TextFieldTextEditEnd: "TextField.Text.Edit.End"

Called when the text edit operation ends for a given text field. This means that the user can no longer enter text via the keyboard. On touch devices, this means that the on screen keyboard may hide.

  • event data: null
  • cannot be cancelled
  • field object holds the active field
TextFieldTextEditKeyPressed: "TextField.Text.Edit.KeyPressed"

Called when text is being entered in a text field. Can be a single character or multiple characters (e.g. pasting text or composition).

TextFieldTextEditStart: "TextField.Text.Edit.Start"

Called when the text edit operation starts for a given text field. This means that the user can now enter text via the keyboard. On touch devices, this means that the on screen keyboard may show.

  • event data: null
  • cannot be cancelled
  • field object holds the active field

Generated using TypeDoc