Class DocumentSettings

Represents the settings and properties of the document that is opened in Document editor component.

Inheritance

System.Object

DocumentSettings

Namespace: Syncfusion.Blazor.DocumentEditor

Assembly: Syncfusion.Blazor.DocumentEditor.dll

Syntax

public class DocumentSettings : Object

Remarks

This property provides an option to modify the compatibility mode of the active document, when a new document is created, or an existing document is opened. You can modify it in DocumentEditorEvents event.

Examples

The following code example demonstrates how to modify compatibility mode for the document opened in Syncfusion Word Processor (Document editor) component.

//Sets compatibility mode for the active document as Word 2010.
sfDocumentEditorContainer.DocumentSettings.CompatibilityMode = CompatibilityMode.Word2010;

Constructors

DocumentSettings()

Declaration

public DocumentSettings()

Properties

CompatibilityMode

Gets or sets the compatability mode of the document. The default value is Word2013.

Declaration

public CompatibilityMode CompatibilityMode { get; set; }

Property Value

Type	Description
CompatibilityMode	Returns the CompatibilityMode of the document.

Remarks

This property provides an option to modify the compatibility mode of the active document, when a new document is created, or an existing document is opened. You can modify it in DocumentEditorEvents event.

Examples

The following code example demonstrates how to modify compatibility mode for the document opened in Syncfusion Word Processor (Document editor) component.

//Sets compatibility mode for the active document as Word 2010.
sfDocumentEditorContainer.DocumentSettings.CompatibilityMode = CompatibilityMode.Word2010;

Methods

Equals(DocumentSettings)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(DocumentSettings documentSettings)

Parameters

Type	Name	Description
DocumentSettings	documentSettings	An DocumentSettings to compare.

Returns

Type	Description
System.Boolean	true if the current object is equal to the other parameter; otherwise, false.