Apryse WebViewer

Class: ContentBox

Core.ContentEdit. ContentBox

The ContentBox class which includes a control handle and an HTML text edit element.

new ContentBox()

Methods

getBoxAttributes()

Gets the attributes pulled at the content box level
Returns:
The attributes pulled at the content box level
Type
Core.ContentEdit.TextAttributes

getBoxData()

Gets the text or object box data used to create the content box.
Returns:
The underlying text-box or object-box data.
Type
Core.ContentEdit.TextBox | Core.ContentEdit.ObjectBox

getEditingSession()

Returns the ContentEditSession (editing session) associated with this content box.
Returns:
The editing session or null if not yet created.
Type
Core.ContentEdit.ContentEditSession | null

getEditor()

Deprecated. Use getEditingSession() instead.
Deprecated:
  • Use Core.ContentEdit.ContentBox#getEditingSession instead.
Returns:
The editing session or null if not yet created.
Type
Core.ContentEdit.ContentBoxEditor | null

getPlaceholderAnnotation()

Gets the placeholder annotation for the content box.
Returns:
The placeholder annotation.
Type
Core.Annotations.RectangleAnnotation

isEditing()

Checks if the content box is currently being edited.
Returns:
True if the content box is currently being edited, false otherwise
Type
boolean

startContentEditing()

Starts editing the content of the content box. Creates the ContentEditSession which owns the input element, then initializes the DOM surface via the session.
Returns:
Type
void

stopContentEditing()

Stops editing the content of the content box. Destroys the session, which removes the input element from the DOM.
Returns:
Type
void