Editor module
Applies the borders based on given settings.
| Parameter | Type | Description |
|---|---|---|
| settings | BorderSettings |
Returns void
Applies the bullet list to selected paragraphs.
| Parameter | Type | Description |
|---|---|---|
| bullet | string |
Bullet character |
| fontFamily | string |
Bullet font family |
Returns void
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
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
Fits the table based on AutoFitType.
Returns void
Determines whether merge cell operation can be done.
Returns boolean
Clears the formatting.
Returns void
Clears the list format for selected paragraphs.
Returns void
Creates a new instance of Style.
Returns void
Moves the selected content in the document editor control to clipboard.
Returns void
Decreases the left indent of selected paragraphs to a factor of 36 points.
Returns void
Remove the current selected content or one character right of cursor.
Returns void
Delete all the comments in current document
Returns void
Deletes the selected column(s).
Returns void
Delete current selected comment.
Returns void
Deletes the selected row(s).
Returns void
Deletes the entire table at selection.
Returns void
Enforce document protection by protection type.
Returns void
Enforce document protection.
Returns void
Increases the left indent of selected paragraphs to a factor of 36 points.
Returns void
Insert Bookmark at current selection range
| Parameter | Type | Description |
|---|---|---|
| name | string |
Name of bookmark |
Returns void
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
Insert comment
| Parameter | Type | Description |
|---|---|---|
| text (optional) | string |
comment text. |
Returns void
Insert editing region where everyone can edit.
Returns void
Insert editing region where mentioned user can edit.
Returns void
Inserts the specified field at cursor position
Returns void
Insert specified form field at current selection.
| Parameter | Type | Description |
|---|---|---|
| type | string |
Form field type |
Returns void
Insert Hyperlink
| Parameter | Type | Description |
|---|---|---|
| address | string |
Hyperlink URL |
| displayText (optional) | string |
Display text for the hyperlink |
Returns void
Inserts the image with specified size at cursor position in the document editor.
Returns void
Insert page break at cursor position
Returns void
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
Insert Section break at cursor position
Returns void
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
Inserts, modifies or updates the table of contents based on given settings.
| Parameter | Type | Description |
|---|---|---|
| tableOfContentsSettings (optional) | TableOfContentsSettings |
Returns void
Inserts the specified text at cursor position
| Parameter | Type | Description |
|---|---|---|
| text | string |
text to insert |
Returns void
Merge the selected cells.
Returns void
Pastes provided sfdt content or the data present in local clipboard if any .
Returns void
Removes the hyperlink if selection is within hyperlink.
Returns void
Stop document protection.
Returns void
Toggles the baseline alignment property of selected contents.
| Parameter | Type | Description |
|---|---|---|
| baseAlignment | string |
Returns void
Toggles the bold property of selected contents.
Returns void
Toggles the highlight color property of selected contents.
| Parameter | Type | Description |
|---|---|---|
| highlightColor (optional) | string |
Default value of ‘underline’ parameter is Yellow. |
Returns void
Toggles the bold property of selected contents.
Returns void
Toggles the strike through property of selected contents.
| Parameter | Type | Description |
|---|---|---|
| strikethrough (optional) | string |
Default value of strikethrough parameter is SingleStrike. |
Returns void
Toggles the subscript formatting of selected contents.
Returns void
Toggles the superscript formatting of selected contents.
Returns void
Toggles the text alignment of selected paragraphs.
| Parameter | Type | Description |
|---|---|---|
| textAlignment | string |
Returns void
Toggles the underline property of selected contents.
| Parameter | Type | Description |
|---|---|---|
| underline (optional) | string |
Default value of ‘underline’ parameter is Single. |
Returns void