Editor API in React DocumentEditor API component

Editor module

Methods

applyBorders

Applies the borders based on given settings.

Returns void

applyBullet

Applies the bullet list to selected paragraphs.

Parameter	Type	Description
bullet	string	Bullet character
fontFamily	string	Bullet font family

Returns void

applyContinueNumbering

To apply continue numbering from the previous list

Returns void

applyNumbering

Applies the numbering list to selected paragraphs.

Parameter	Type	Description
numberFormat	string	“%n” representations in ‘numberFormat’ parameter will be replaced by respective list level’s value. “%1)” will be displayed as “1)”
listLevelPattern (optional)	string	Default value of ‘listLevelPattern’ parameter is ListLevelPattern.Arabic

Returns void

applyStyle

To update style for paragraph

Parameter	Type	Description
style	string	style name
clearDirectFormatting (optional)	boolean	Removes manual formatting (formatting not applied using a style) from the selected text, to match the formatting of the applied style. Default value is false.

Returns void

autoFitTable

Fits the table based on AutoFitType.

Returns void

canMergeCells

Determines whether merge cell operation can be done.

Returns boolean

clearFormatting

Clears the formatting.

Returns void

clearList

Clears the list format for selected paragraphs.

Returns void

createStyle

Creates a new instance of Style.

Returns void

cut

Moves the selected content in the document editor control to clipboard.

Returns void

decreaseIndent

Decreases the left indent of selected paragraphs to a factor of 36 points.

Returns void

delete

Remove the current selected content or one character right of cursor.

Returns void

deleteAllComments

Delete all the comments in current document

Returns void

deleteBookmark

Deletes specific bookmark

Parameter	Type	Description
bookmarkName	string	Name of bookmark to delete.

Returns void

deleteColumn

Deletes the selected column(s).

Returns void

deleteComment

Delete current selected comment.

Returns void

deleteRow

Deletes the selected row(s).

Returns void

deleteTable

Deletes the entire table at selection.

Returns void

enforceProtection

Enforce document protection by protection type.

Returns void

enforceProtection

Enforce document protection.

Returns void

increaseIndent

Increases the left indent of selected paragraphs to a factor of 36 points.

Returns void

insertBookmark

Insert Bookmark at current selection range

Parameter	Type	Description
name	string	Name of bookmark

Returns void

insertColumn

Inserts the specified number of columns to the table left or right to the column at cursor position.

Parameter	Type	Description
left (optional)	boolean	The left parameter is optional and if omitted, it takes the value as false and inserts to the right of column at cursor position.
count (optional)	number	The count parameter is optional and if omitted, it takes the value as 1.

Returns void

insertComment

Insert comment

Parameter	Type	Description
text (optional)	string	comment text.

Returns void

insertEditingRegion

Insert editing region where everyone can edit.

Returns void

insertEditingRegion

Insert editing region where mentioned user can edit.

Parameter	Type	Description
user	string	Specified the native rendering

Returns void

insertEndnote

Insert Endnote at current selection

Returns void

insertField

Inserts the specified field at cursor position

Parameter	Type	Description
code	string	Specify the field code
result (optional)	string	Specify the field result

Returns void

insertFootnote

Insert Footnote at current selection

Returns void

insertFormField

Insert specified form field at current selection.

Parameter	Type	Description
type	string	Form field type

Returns void

insertHyperlink

Insert Hyperlink

Parameter	Type	Description
address	string	Hyperlink URL
displayText (optional)	string	Display text for the hyperlink

Returns void

insertImage

Inserts the image with specified size at cursor position in the document editor.

Returns void

insertPageBreak

Insert page break at cursor position

Returns void

insertPageNumber

Insert page number in the current cursor position.

Parameter	Type	Description
numberFormat (optional)	string	Optional switch that overrides the numeral style of the page number.

Returns void

insertRow

Inserts the specified number of rows to the table above or below to the row at cursor position.

Parameter	Type	Description
above (optional)	boolean	The above parameter is optional and if omitted, it takes the value as false and inserts below the row at cursor position.
count (optional)	number	The count parameter is optional and if omitted, it takes the value as 1.

Returns void

insertSectionBreak

Insert Section break at cursor position

Returns void

insertTable

Inserts a table of specified size at cursor position in the document editor.

Parameter	Type	Description
rows (optional)	number	Default value of ‘rows’ parameter is 1.
columns (optional)	number	Default value of ‘columns’ parameter is 1.

Returns void

insertTableOfContents

Inserts, modifies or updates the table of contents based on given settings.

Returns void

insertText

Inserts the specified text at cursor position

Parameter	Type	Description
text	string	text to insert

Returns void

mergeCells

Merge the selected cells.

Returns void

paste

Pastes provided sfdt content or the data present in local clipboard if any.

Returns void

removeHyperlink

Removes the hyperlink if selection is within hyperlink.

Returns void

stopProtection

Stop document protection.

Parameter	Type	Description
password	string	Specifies the password

Returns void

toggleAllCaps

Toggle All Caps formatting for the selected content.

Returns void

toggleBaselineAlignment

Toggles the baseline alignment property of selected contents.

Parameter	Type	Description
baseAlignment	string	Specifies the baseline alignment

Returns void

toggleBold

Toggles the bold property of selected contents.

Returns void

toggleHighlightColor

Toggles the highlight color property of selected contents.

Parameter	Type	Description
highlightColor (optional)	string	Default value of ‘underline’ parameter is Yellow.

Returns void

toggleItalic

Toggles the bold property of selected contents.

Returns void

toggleStrikethrough

Toggles the strike through property of selected contents.

Parameter	Type	Description
strikethrough (optional)	string	Default value of strikethrough parameter is SingleStrike.

Returns void

toggleSubscript

Toggles the subscript formatting of selected contents.

Returns void

toggleSuperscript

Toggles the superscript formatting of selected contents.

Returns void

toggleTextAlignment

Toggles the text alignment of selected paragraphs.

Parameter	Type	Description
textAlignment	string	Specified the text alignment.

Returns void

toggleUnderline

Toggles the underline property of selected contents.

Parameter	Type	Description
underline (optional)	string	Default value of ‘underline’ parameter is Single.

Returns void