Class DocumentEditorSettingsModel
Interface for a class DocumentEditorSettings.
Inheritance
Namespace: Syncfusion.Blazor.DocumentEditor
Assembly: Syncfusion.Blazor.DocumentEditor.dll
Syntax
public class DocumentEditorSettingsModel : Object
Constructors
DocumentEditorSettingsModel()
Declaration
public DocumentEditorSettingsModel()
Properties
AllowDragAndDrop
Gets or sets a value indicating whether to allow dragging and dropping the selected content within Document editor.
Declaration
public bool AllowDragAndDrop { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The value |
EnableOptimizedTextMeasuring
Gets or sets a value indicating whether to use optimized text measuring approach to match Microsoft Word pagination.
Declaration
public bool EnableOptimizedTextMeasuring { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true use optimized text measuring approach to match Microsoft Word pagination; otherwise, false |
FontFamilies
Specifies the user preferred font family of Document Editor.
Declaration
public string[] FontFamilies { get; set; }
Property Value
Type | Description |
---|---|
System.String[] |
FormFieldSettings
Form field settings.
Declaration
public FormFieldSettingsModel FormFieldSettings { get; set; }
Property Value
Type | Description |
---|---|
FormFieldSettingsModel |
OptimizeSfdt
Gets or sets a value indicating whether to reduce the resultant SFDT file size by minifying the file content. The default value is true.
Declaration
public bool OptimizeSfdt { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | 'True' if the resultant SFDT file size is reduced by minifying the file content. Otherwise 'False'. |
Remarks
The value `false` means the sfdt content are not optimized. The value `true` means generate the optimized sfdt.
Examples
The following code example demonstrates how to generate the Sfdt without optimization in Syncfusion Word Processor (Document editor) component.
WordDocument document = WordDocument.Load(stream, GetFormatType(type.ToLower()));
//Disables the optimized sfdt.
document.OptimizeSfdt = false;
string json = Newtonsoft.Json.JsonConvert.SerializeObject(document);
document.Dispose();
PrintDevicePixelRatio
Specifies the device pixel ratio for the image generated for printing. Remarks: Increasing the device pixel ratio will increase the image file size, due to high resolution of image.
Declaration
public int PrintDevicePixelRatio { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
SearchHighlightColor
Specifies the user preferred Search Highlight Color of Document Editor.
Declaration
public string SearchHighlightColor { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ShowBookmarks
Gets or sets a value indicating whether to display square brackets at the beginning and end of each bookmark. The default value is false.
Declaration
public bool ShowBookmarks { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | True if square brackets are displayed at the beginning and end of each bookmark. |
Remarks
True if square brackets are displayed at the beginning and end of each bookmark. Otherwise false
Examples
The following code example demonstrates how to display square brackets at the beginning and end of each bookmark in Syncfusion Word Processor (Document editor) component.
//Displays the square brackets at the beginning and end of each bookmark in Document editor component.
sfDocumentEditorContainer.DocumentEditorSettings.ShowBookmarks = true;
ShowHiddenMarks
Gets or sets a value indicating whether to show the hidden characters like spaces, tab, paragraph marks, and breaks. The default value is false.
Declaration
public bool ShowHiddenMarks { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | Returns the value to show/hide hidden characters like spaces, tab, paragraph marks, and breaks. |
Remarks
The value `false` means hide the hidden characters like spaces, tab, paragraph marks, and breaks. The value `true` means show the hidden characters.
Examples
The following code example demonstrates how to show the hidden characters like spaces, tab, paragraph marks, and breaks in Syncfusion Word Processor (Document editor) component.
//Displays the hidden characters in Document editor component.
sfDocumentEditorContainer.DocumentEditorSettings.ShowHiddenMarks = true;
Methods
Dispose()
Dispose unmanaged resources used in DocumentEditorSettingsModel.
Declaration
public void Dispose()
Equals(DocumentEditorSettingsModel)
Indicates whether the current object is equal to another object of the same type.
Declaration
public bool Equals(DocumentEditorSettingsModel documentEditorSettingsModel)
Parameters
Type | Name | Description |
---|---|---|
DocumentEditorSettingsModel | documentEditorSettingsModel | An DocumentEditorSettingsModel to compare. |
Returns
Type | Description |
---|---|
System.Boolean | true if the current object is equal to the other parameter; otherwise, false. |