DocumentEditorSettings

23 Sep 20252 minutes to read

The DocumentEditorSettings module is used to provide the customize property of Document Editor.

Properties

allowDragAndDrop boolean

Enable or Disable moving selected content within Document Editor

Defaults to true

autoResizeSettings AutoResizeSettingsModel

Specified the auto resize settings.

collaborativeEditingSettings CollaborativeEditingSettingsModel

Gets ot sets the collaborative editing settings.

colorPickerSettings ColorPickerModel

Gets or sets color picker settings to customize the color picker used in Document Editor.

enableOptimizedTextMeasuring boolean

Gets or sets a value indicating whether to use optimized text measuring approach to match Microsoft Word pagination.

Defaults to true

enableScreenReader boolean

Enables or disables screen reader support in the Document Editor. When set to true, the editor will expose necessary accessibility information for screen reader tools.

Defaults to false

fontFamilies string[]

Specifies the user preferred font family of Document Editor.

Defaults to [‘Algerian’,’Arial’,’Calibri’,’Cambria’,’CambriaMath’,’Candara’,’CourierNew’,’Georgia’,’Impact’,’SegoePrint’,’SegoeScript’,’SegoeUI’,’Symbol’,’TimesNewRoman’,’Verdana’,’Wingdings’]

formFieldSettings FormFieldSettingsModel

Gets or sets the form field settings.

highlightEditableRanges boolean

Gets or sets a value indicating whether to highlight the editable ranges in the document where the current user can edit.

Defaults to true

maximumColumns number

Gets or sets the maximum number of columns allowed while inserting a table in Document editor component.

The maximum value is 63, as per Microsoft Word application and you can set any value less than 63 to this property. If you set any value greater than 63, then Syncfusion Document editor will automatically reset as 63.

Defaults to 63

maximumRows number

Gets or sets the maximum number of rows allowed while inserting a table in Document editor component.

The maximum value is 32767, as per Microsoft Word application and you can set any value less than 32767 to this property. If you set any value greater than 32767, then Syncfusion Document editor will automatically reset as 32767.

Defaults to 32767

mentionSettings MentionModel

Gets ot sets the mention configuration used in Document Editor.

optimizeSfdt boolean

Describes whether to reduce the resultant SFDT file size by minifying the file content

Defaults to true

pasteAsNewParagraph boolean

Gets or sets a value indicating whether the final paragraph of pasted content should be appended as a new paragraph in the Document Editor.

Defaults to false

popupTarget HTMLElement

Gets or sets a value indicating where to append the pop up element

Defaults to null

printDevicePixelRatio number

Specifies the device pixel ratio for the image generated for printing.

Increasing the device pixel ratio will increase the image file size, due to high resolution of image.

revisionSettings RevisionSettingsModel

Gets or sets the revision settings.

searchHighlightColor string

Specifies the user preferred Search Highlight Color of Document Editor.

Defaults to ‘#FFE97F’

showBookmarks boolean

Gets or sets a value indicating whether to show square brackets around bookmarked items.

Defaults to false

showHiddenMarks boolean

Gets or sets a value indicating whether to show the hidden characters like spaces, tab, paragraph marks, and breaks.

Defaults to false

showNavigationPane boolean

Gets or sets a value indicating whether to display navigation pane in Document Editor.

Defaults to false

showRuler boolean

Gets or sets a value indicating whether to display ruler in Document Editor.

Defaults to false