diff --git a/Document-Processing-toc.html b/Document-Processing-toc.html index 96f0cff67..c00f5e45e 100644 --- a/Document-Processing-toc.html +++ b/Document-Processing-toc.html @@ -2958,6 +2958,7 @@
  • Working with Table Formatting
  • Working with Section Formatting
  • Comments
    • +
  • Track Changes
  • Fields
  • Form fields
  • Clipboard
    • diff --git a/Document-Processing/Word/Word-Processor/angular/images/track-changes-customData.png b/Document-Processing/Word/Word-Processor/angular/images/track-changes-customData.png new file mode 100644 index 000000000..cf1fdff50 Binary files /dev/null and b/Document-Processing/Word/Word-Processor/angular/images/track-changes-customData.png differ diff --git a/Document-Processing/Word/Word-Processor/angular/spell-check.md b/Document-Processing/Word/Word-Processor/angular/spell-check.md index 8cd8f7e2b..184898e7e 100644 --- a/Document-Processing/Word/Word-Processor/angular/spell-check.md +++ b/Document-Processing/Word/Word-Processor/angular/spell-check.md @@ -162,4 +162,4 @@ Using this option, you can open spell check dialog. Please see below screenshot ![Spell check dialog](images/spell-check-dialog.png) -* Refer to the [Spell checker](https://help.syncfusion.com/document-processing/word/word-processor/angular/web-services/core#spell-check) link for configuring spell checker in server-side. \ No newline at end of file +* Refer to the [Spell checker](https://help.syncfusion.com/document-processing/word/word-processor/angular/web-services/core#spell-check) link for configuring spell checker in server-side. diff --git a/Document-Processing/Word/Word-Processor/angular/track-changes.md b/Document-Processing/Word/Word-Processor/angular/track-changes.md index 24d8a50e7..95d9bc4b1 100644 --- a/Document-Processing/Word/Word-Processor/angular/track-changes.md +++ b/Document-Processing/Word/Word-Processor/angular/track-changes.md @@ -105,11 +105,57 @@ In DocumentEditor, we have built-in review panel in which we have provided suppo ![Track changes](images/tracked-changes.png) +## Custom metadata along with author + +The Document Editor provides options to customize revisions using [`revisionSettings`](https://ej2.syncfusion.com/angular/documentation/api/document-editor/documenteditorsettingsmodel#revisionsettings). The [`customData`](https://ej2.syncfusion.com/angular/documentation/api/document-editor/revisionsettings#customdata) property allows you to attach additional metadata to tracked revisions in the Word Processor. This metadata can represent roles, tags, or any custom identifier for the revision. To display this metadata along with the author name in the Track Changes pane, you must enable the [`showCustomDataWithAuthor`](https://ej2.syncfusion.com/angular/documentation/api/document-editor/revisionsettings#showcustomdatawithauthor) property. + +The following example code illustrates how to enable and update custom metadata for track changes revisions. + +```ts +import { Component, OnInit, ViewChild } from '@angular/core'; +import { + ToolbarService, + DocumentEditorContainerComponent, +} from '@syncfusion/ej2-angular-documenteditor'; +import { DocumentEditorContainerModule } from '@syncfusion/ej2-angular-documenteditor'; +@Component({ + selector: 'app-container', + standalone: true, + imports: [DocumentEditorContainerModule], + providers: [ToolbarService], + template: ` + + `, +}) +export class AppComponent implements OnInit { + @ViewChild('documenteditor_default') + public container?: DocumentEditorContainerComponent; + public Settings = { + revisionSettings: { + customData: 'Developer', + showCustomDataWithAuthor: true, + }}; + ngOnInit(): void {} +} +``` +The Track Changes pane will display the author name along with the custom metadata, as shown in the screenshot below. + +![Custom metadata along with author](images/track-changes-customData.png) + +>Note: +* When you export the document as SFDT, the customData value is stored in the revision collection. When you reopen the SFDT, the custom data is automatically restored and displayed in the Track Changes pane. +* Other than SFDT export (e.g. DOCX and other), the customData is not preserved, as it is specific to the Document Editor component. + ## Protect the document in track changes only mode Document Editor provides support for protecting the document with `RevisionsOnly` protection. In this protection, all the users are allowed to view the document and do their corrections, but they cannot accept or reject any tracked changes in the document. Later, the author can view their corrections and accept or reject the changes. -Document editor provides an option to protect and unprotect document using [`enforceProtection`](https://ej2.syncfusion.com/angular/documentation/api/document-editor/editor/#enforceprotection) and [`stopProtection`](https://ej2.syncfusion.com/angular/documentation/api/document-editor/editor/#stopprotection) API. +Document editor provides an option to protect and unprotect document using [`enforceProtection`](https://ej2.syncfusion.com/angular/documentation/api/document-editor/editor#enforceprotection) and [`stopProtection`](https://ej2.syncfusion.com/angular/documentation/api/document-editor/editor#stopprotection) API. The following example code illustrates how to enforce and stop protection in Document editor container. diff --git a/Document-Processing/Word/Word-Processor/asp-net-core/images/track-changes-customData.png b/Document-Processing/Word/Word-Processor/asp-net-core/images/track-changes-customData.png new file mode 100644 index 000000000..cf1fdff50 Binary files /dev/null and b/Document-Processing/Word/Word-Processor/asp-net-core/images/track-changes-customData.png differ diff --git a/Document-Processing/Word/Word-Processor/asp-net-core/spell-check.md b/Document-Processing/Word/Word-Processor/asp-net-core/spell-check.md index 9b7278ee1..8eed1e170 100644 --- a/Document-Processing/Word/Word-Processor/asp-net-core/spell-check.md +++ b/Document-Processing/Word/Word-Processor/asp-net-core/spell-check.md @@ -145,4 +145,4 @@ Using this option, you can open spell check dialog. ![Spell check dialog](images/spell-check-dialog.png) -* Refer to the [Spell checker](https://github.com/SyncfusionExamples/EJ2-Document-Editor-Web-Services/tree/master/ASP.NET%20Core#steps-to-configure-spell-checker) link for configuring spell checker in server-side. \ No newline at end of file +* Refer to the [Spell checker](https://github.com/SyncfusionExamples/EJ2-Document-Editor-Web-Services/tree/master/ASP.NET%20Core#steps-to-configure-spell-checker) link for configuring spell checker in server-side. diff --git a/Document-Processing/Word/Word-Processor/asp-net-core/track-changes.md b/Document-Processing/Word/Word-Processor/asp-net-core/track-changes.md index 53d8823e9..536dbf1c1 100644 --- a/Document-Processing/Word/Word-Processor/asp-net-core/track-changes.md +++ b/Document-Processing/Word/Word-Processor/asp-net-core/track-changes.md @@ -129,6 +129,29 @@ In DocumentEditor, we have built-in review panel in which we have provided suppo ![Track changes](images/track-changes.png) +## Custom metadata along with author + +The Document Editor provides options to customize revisions using `revisionSettings`. The `customData` property allows you to attach additional metadata to tracked revisions in the Word Processor. This metadata can represent roles, tags, or any custom identifier for the revision. To display this metadata along with the author name in the Track Changes pane, you must enable the `showCustomDataWithAuthor` property. + +The following example code illustrates how to enable and update custom metadata for track changes revisions. + +{% tabs %} +{% highlight cshtml tabtitle="CSHTML" %} +{% include code-snippet/document-editor/asp-net-core/document-editor-container/track-changes-revisionSettings/tagHelper %} +{% endhighlight %} +{% highlight c# tabtitle="Track-changes-only.cs" %} +{% include code-snippet/document-editor/asp-net-core/document-editor-container/track-changes-revisionSettings/document-editor.cs %} +{% endhighlight %} +{% endtabs %} + +The Track Changes pane will display the author name along with the custom metadata, as shown in the screenshot below. + +![Custom metadata along with author](images/track-changes-customData.png) + +>Note: +* When you export the document as SFDT, the customData value is stored in the revision collection. When you reopen the SFDT, the custom data is automatically restored and displayed in the Track Changes pane. +* Other than SFDT export (e.g. DOCX and other), the customData is not preserved, as it is specific to the Document Editor component. + ## Protect the document in track changes only mode Document Editor provides support for protecting the document with `RevisionsOnly` protection. In this protection, all the users are allowed to view the document and do their corrections, but they cannot accept or reject any tracked changes in the document. Later, the author can view their corrections and accept or reject the changes. diff --git a/Document-Processing/Word/Word-Processor/asp-net-mvc/images/track-changes-customData.png b/Document-Processing/Word/Word-Processor/asp-net-mvc/images/track-changes-customData.png new file mode 100644 index 000000000..cf1fdff50 Binary files /dev/null and b/Document-Processing/Word/Word-Processor/asp-net-mvc/images/track-changes-customData.png differ diff --git a/Document-Processing/Word/Word-Processor/asp-net-mvc/spell-check.md b/Document-Processing/Word/Word-Processor/asp-net-mvc/spell-check.md index 62f5b81cd..867e72561 100644 --- a/Document-Processing/Word/Word-Processor/asp-net-mvc/spell-check.md +++ b/Document-Processing/Word/Word-Processor/asp-net-mvc/spell-check.md @@ -68,6 +68,14 @@ Document editor provides option to spellcheck page by page when loading the docu this.container.documentEditor.spellChecker.enableOptimizedSpellCheck = true; ``` +### EnableUserDictionary + +By default, Document Editor maintains a shared custom dictionary for all users. You can enable user-specific dictionary support using the `enableUserDictionary` API, which stores and retrieves error words based on the `currentUser` property. + +```typescript +this.container.documentEditor.spellChecker.enableUserDictionary = true; +``` + ### Spell check dictionary cache Starting from `v20.1.0.xx`, the performance and memory usage of spell checker has been optimized by adding a static method to initialize the dictionaries with specified cache count. diff --git a/Document-Processing/Word/Word-Processor/asp-net-mvc/track-changes.md b/Document-Processing/Word/Word-Processor/asp-net-mvc/track-changes.md index 4d92f624c..99096fc7a 100644 --- a/Document-Processing/Word/Word-Processor/asp-net-mvc/track-changes.md +++ b/Document-Processing/Word/Word-Processor/asp-net-mvc/track-changes.md @@ -124,6 +124,29 @@ In DocumentEditor, we have built-in review panel in which we have provided suppo ![Track changes](images/track-changes.png) +## Custom metadata along with author + +The Document Editor provides options to customize revisions using `revisionSettings`. The `customData` property allows you to attach additional metadata to tracked revisions in the Word Processor. This metadata can represent roles, tags, or any custom identifier for the revision. To display this metadata along with the author name in the Track Changes pane, you must enable the `showCustomDataWithAuthor` property. + +The following example code illustrates how to enable and update custom metadata for track changes revisions. + +{% tabs %} +{% highlight razor tabtitle="CSHTML" %} +{% include code-snippet/document-editor/asp-net-mvc/document-editor-container/track-changes-revisionSettings/razor %} +{% endhighlight %} +{% highlight c# tabtitle="Track-changes.cs" %} +{% include code-snippet/document-editor/asp-net-mvc/document-editor-container/track-changes-revisionSettings/document-editor.cs %} +{% endhighlight %} +{% endtabs %} + +The Track Changes pane will display the author name along with the custom metadata, as shown in the screenshot below. + +![Custom metadata along with author](images/track-changes-customData.png) + +>Note: +* When you export the document as SFDT, the customData value is stored in the revision collection. When you reopen the SFDT, the custom data is automatically restored and displayed in the Track Changes pane. +* Other than SFDT export (e.g. DOCX and other), the customData is not preserved, as it is specific to the Document Editor component. + ## Protect the document in track changes only mode Document Editor provides support for protecting the document with `RevisionsOnly` protection. In this protection, all the users are allowed to view the document and do their corrections, but they cannot accept or reject any tracked changes in the document. Later, the author can view their corrections and accept or reject the changes. @@ -142,7 +165,7 @@ The following example code illustrates how to enforce and stop protection in Doc {% endhighlight %} {% endtabs %} -Tracked changes only protection can be enabled in UI by using [Restrict Editing pane](./document-management#restrict-editing-pane/) +Tracked changes only protection can be enabled in UI by using [Restrict Editing pane](./document-management#restrict-editing-pane) ![Enable track changes only protection](images/tracked-changes.png) diff --git a/Document-Processing/Word/Word-Processor/blazor/images/track-changes-customData.png b/Document-Processing/Word/Word-Processor/blazor/images/track-changes-customData.png new file mode 100644 index 000000000..cf1fdff50 Binary files /dev/null and b/Document-Processing/Word/Word-Processor/blazor/images/track-changes-customData.png differ diff --git a/Document-Processing/Word/Word-Processor/blazor/track-changes.md b/Document-Processing/Word/Word-Processor/blazor/track-changes.md index 01c9b5a76..5618e405b 100644 --- a/Document-Processing/Word/Word-Processor/blazor/track-changes.md +++ b/Document-Processing/Word/Word-Processor/blazor/track-changes.md @@ -85,6 +85,32 @@ In DocumentEditor, we have built-in review panel in which we have provided suppo ![Track changes in Blazor DocumentEditor](images/track-changes.png) +## Custom metadata along with author + +The Document Editor provides options to customize revisions using [`RevisionSettings`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DocumentEditor.DocumentEditorSettingsModel.html#Syncfusion_Blazor_DocumentEditor_DocumentEditorSettingsModel_RevisionSettings). The `CustomData` property allows you to attach additional metadata to tracked revisions in the Word Processor. This metadata can represent roles, tags, or any custom identifier for the revision. To display this metadata along with the author name in the Track Changes pane, you must enable the `ShowCustomDataWithAuthor` property. + +The following example code illustrates how to enable and update custom metadata for track changes revisions. + +```ts +@using Syncfusion.Blazor.DocumentEditor + + + +@code { + SfDocumentEditorContainer container; + DocumentEditorSettingsModel settings = new DocumentEditorSettingsModel() + { RevisionSettings= { CustomData = "Developer", ShowCustomDataWithAuthor = true}}; +} +``` + +The Track Changes pane will display the author name along with the custom metadata, as shown in the screenshot below. + +![Custom metadata along with author](images/track-changes-customData.png) + +>Note: +* When you export the document as SFDT, the customData value is stored in the revision collection. When you reopen the SFDT, the custom data is automatically restored and displayed in the Track Changes pane. +* Other than SFDT export (e.g. DOCX and other), the customData is not preserved, as it is specific to the Document Editor component. + ## Protect the document in track changes only mode Document Editor provides support for protecting the document with `RevisionsOnly` protection. In this protection, all the users are allowed to view the document and do their corrections, but they cannot accept or reject any tracked changes in the document. Later, the author can view their corrections and accept or reject the changes. diff --git a/Document-Processing/Word/Word-Processor/javascript-es5/images/track-changes-customData.png b/Document-Processing/Word/Word-Processor/javascript-es5/images/track-changes-customData.png new file mode 100644 index 000000000..cf1fdff50 Binary files /dev/null and b/Document-Processing/Word/Word-Processor/javascript-es5/images/track-changes-customData.png differ diff --git a/Document-Processing/Word/Word-Processor/javascript-es5/spell-check.md b/Document-Processing/Word/Word-Processor/javascript-es5/spell-check.md index 4ee986a79..159f81a3f 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es5/spell-check.md +++ b/Document-Processing/Word/Word-Processor/javascript-es5/spell-check.md @@ -80,6 +80,13 @@ The following code example illustrates how to enable optimized spell checking. ```ts documentEditor.spellChecker.enableOptimizedSpellCheck = true; ``` +### EnableUserDictionary + +By default, Document Editor maintains a shared custom dictionary for all users. You can enable user-specific dictionary support using the [`enableUserDictionary`](https://ej2.syncfusion.com/javascript/documentation/api/document-editor/spellchecker#enableuserdictionary-boolean) API, which stores and retrieves error words based on the `currentUser` property. + +```typescript +documentEditor.spellChecker.enableUserDictionary = true; +``` ### Spell check dictionary cache diff --git a/Document-Processing/Word/Word-Processor/javascript-es5/track-changes.md b/Document-Processing/Word/Word-Processor/javascript-es5/track-changes.md index 247ad0b38..4cce2dc4c 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es5/track-changes.md +++ b/Document-Processing/Word/Word-Processor/javascript-es5/track-changes.md @@ -123,6 +123,35 @@ container.documentEditor.selection.navigateNextRevision(); */ container.documentEditor.selection.navigatePreviousRevision(); ``` +## Custom metadata along with author + +The Document Editor provides options to customize revisions using [`revisionSettings`](https://ej2.syncfusion.com/javascript/documentation/api/document-editor/documenteditorsettingsmodel#revisionsettings). The [`customData`](https://ej2.syncfusion.com/javascript/documentation/api/document-editor/revisionsettings#customdata) property allows you to attach additional metadata to tracked revisions in the Word Processor. This metadata can represent roles, tags, or any custom identifier for the revision. To display this metadata along with the author name in the Track Changes pane, you must enable the [`showCustomDataWithAuthor`](https://ej2.syncfusion.com/javascript/documentation/api/document-editor/revisionsettings#showcustomdatawithauthor) property. + +The following example code illustrates how to enable and update custom metadata for track changes revisions. + +```js +var container = new ej.documenteditor.DocumentEditor({ + serviceUrl: hostUrl, + height: '590px', + enableTrackChanges: true, + documentEditorSettings: { + revisionSettings: { + customData: 'Developer', + showCustomDataWithAuthor: true + }} +}); +DocumentEditorContainer.Inject(Toolbar); +container.appendTo('#container'); + +``` + +The Track Changes pane will display the author name along with the custom metadata, as shown in the screenshot below. + +![Custom metadata along with author](images/track-changes-customData.png) + +>Note: +* When you export the document as SFDT, the customData value is stored in the revision collection. When you reopen the SFDT, the custom data is automatically restored and displayed in the Track Changes pane. +* Other than SFDT export (e.g. DOCX and other), the customData is not preserved, as it is specific to the Document Editor component. ## Filtering changes based on user diff --git a/Document-Processing/Word/Word-Processor/javascript-es6/images/track-changes-customData.png b/Document-Processing/Word/Word-Processor/javascript-es6/images/track-changes-customData.png new file mode 100644 index 000000000..cf1fdff50 Binary files /dev/null and b/Document-Processing/Word/Word-Processor/javascript-es6/images/track-changes-customData.png differ diff --git a/Document-Processing/Word/Word-Processor/javascript-es6/spell-check.md b/Document-Processing/Word/Word-Processor/javascript-es6/spell-check.md index 59d8262a6..53fc27a82 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es6/spell-check.md +++ b/Document-Processing/Word/Word-Processor/javascript-es6/spell-check.md @@ -81,6 +81,14 @@ The following code example illustrates how to enable optimized spell checking. documentEditor.spellChecker.enableOptimizedSpellCheck = true; ``` +### EnableUserDictionary + +By default, Document Editor maintains a shared custom dictionary for all users. You can enable user-specific dictionary support using the [`enableUserDictionary`](https://ej2.syncfusion.com/documentation/api/document-editor/spellchecker#enableuserdictionary-boolean) API, which stores and retrieves error words based on the [`currentUser`] property. + +```ts +documentEditor.spellChecker.enableUserDictionary = true; +``` + ### Spell check dictionary cache Starting from `v20.1.0.xx`, we have optimized the performance and memory usage of spell checker by adding a static method to initialize the dictionaries with specified cache count. diff --git a/Document-Processing/Word/Word-Processor/javascript-es6/track-changes.md b/Document-Processing/Word/Word-Processor/javascript-es6/track-changes.md index 4a79d669f..fb1808af7 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es6/track-changes.md +++ b/Document-Processing/Word/Word-Processor/javascript-es6/track-changes.md @@ -168,6 +168,33 @@ In DocumentEditor, we have built-in review panel in which we have provided suppo ![Track changes](images/track-changes.png) +## Custom metadata along with author + +The Document Editor provides options to customize revisions using [`revisionSettings`](https://ej2.syncfusion.com/documentation/api/document-editor/documenteditorsettingsmodel#revisionsettings). The [`customData`](https://ej2.syncfusion.com/documentation/api/document-editor/revisionsettings#customdata) property allows you to attach additional metadata to tracked revisions in the Word Processor. This metadata can represent roles, tags, or any custom identifier for the revision. To display this metadata along with the author name in the Track Changes pane, you must enable the [`showCustomDataWithAuthor`](https://ej2.syncfusion.com/documentation/api/document-editor/revisionsettings#showcustomdatawithauthor) property. + +The following example code illustrates how to enable and update custom metadata for track changes revisions. + +```ts +import { DocumentEditorContainer, Toolbar } from '@syncfusion/ej2-documenteditor'; +let container: DocumentEditorContainer = new DocumentEditorContainer({ + height: '590px', + serviceUrl= hostUrl, + enableTrackChanges=true, + documentEditorSettings: { + revisionSettings: { customData : "Developer", showCustomDataWithAuthor : true }} +}); +DocumentEditorContainer.Inject(Toolbar); +container.appendTo('#container'); +``` + +The Track Changes pane will display the author name along with the custom metadata, as shown in the screenshot below. + +![Custom metadata along with author](images/track-changes-customData.png) + +>Note: +* When you export the document as SFDT, the customData value is stored in the revision collection. When you reopen the SFDT, the custom data is automatically restored and displayed in the Track Changes pane. +* Other than SFDT export (e.g. DOCX and other), the customData is not preserved, as it is specific to the Document Editor component. + ## Protect the document in track changes only mode Document Editor provides support for protecting the document with `RevisionsOnly` protection. In this protection, all the users are allowed to view the document and do their corrections, but they cannot accept or reject any tracked changes in the document. Later, the author can view their corrections and accept or reject the changes. diff --git a/Document-Processing/Word/Word-Processor/react/images/track-changes-customData.png b/Document-Processing/Word/Word-Processor/react/images/track-changes-customData.png new file mode 100644 index 000000000..cf1fdff50 Binary files /dev/null and b/Document-Processing/Word/Word-Processor/react/images/track-changes-customData.png differ diff --git a/Document-Processing/Word/Word-Processor/react/spell-check.md b/Document-Processing/Word/Word-Processor/react/spell-check.md index dd30e68f7..028177b80 100644 --- a/Document-Processing/Word/Word-Processor/react/spell-check.md +++ b/Document-Processing/Word/Word-Processor/react/spell-check.md @@ -110,6 +110,13 @@ The following code example illustrates how to enable optimized spell checking. ```ts documentEditor.spellChecker.enableOptimizedSpellCheck = true; ``` +### EnableUserDictionary + +By default, Document Editor maintains a shared custom dictionary for all users. You can enable user-specific dictionary support using the [`enableUserDictionary`](https://ej2.syncfusion.com/react/documentation/api/document-editor/spellchecker#enableuserdictionary-boolean) API, which stores and retrieves error words based on the `currentUser` property. + +```ts +documentEditor.spellChecker.enableUserDictionary = true; +``` ### Spell check dictionary cache diff --git a/Document-Processing/Word/Word-Processor/react/track-changes.md b/Document-Processing/Word/Word-Processor/react/track-changes.md index 2cc7316ca..3f919eb68 100644 --- a/Document-Processing/Word/Word-Processor/react/track-changes.md +++ b/Document-Processing/Word/Word-Processor/react/track-changes.md @@ -189,11 +189,52 @@ In DocumentEditor, we have built-in review panel in which we have provided suppo ![Track changes](images/track-changes.png) +## Custom metadata along with author + +The Document Editor provides options to customize revisions using [`revisionSettings`](https://ej2.syncfusion.com/react/documentation/api/document-editor/documenteditorsettingsmodel#revisionsettings). The [`customData`](https://ej2.syncfusion.com/react/documentation/api/document-editor/revisionsettings#customdata) property allows you to attach additional metadata to tracked revisions in the Word Processor. This metadata can represent roles, tags, or any custom identifier for the revision. To display this metadata along with the author name in the Track Changes pane, you must enable the [`showCustomDataWithAuthor`](https://ej2.syncfusion.com/react/documentation/api/document-editor/revisionsettings#showcustomdatawithauthor) property. + +The following example code illustrates how to enable and update custom metadata for track changes revisions. + +```ts +import * as ReactDOM from 'react-dom'; +import * as React from 'react'; +import { + DocumentEditorContainerComponent, + Ribbon, +} from '@syncfusion/ej2-react-documenteditor'; + +DocumentEditorContainerComponent.Inject(Ribbon); +function App() { + let container; + let settings = { revisionSettings: { customData: 'Developer’, showCustomDataWithAuthor: true} }; + return ( + { + container = scope; + }} + height={'590px'} + serviceUrl="HostUrl" + enableTrackChanges={true} + documentEditorSettings={settings} + /> + ); +} +export default App; +ReactDOM.render(, document.getElementById('sample')); + +``` +The Track Changes pane will display the author name along with the custom metadata, as shown in the screenshot below. +![Custom metadata along with author](images/track-changes-customData.png) +>Note: +* When you export the document as SFDT, the customData value is stored in the revision collection. When you reopen the SFDT, the custom data is automatically restored and displayed in the Track Changes pane. +* Other than SFDT export (e.g. DOCX and other), the customData is not preserved, as it is specific to the Document Editor component. + ## Protect the document in track changes only mode Document Editor provides support for protecting the document with `RevisionsOnly` protection. In this protection, all the users are allowed to view the document and do their corrections, but they cannot accept or reject any tracked changes in the document. Later, the author can view their corrections and accept or reject the changes. -Document editor provides an option to protect and unprotect document using [`enforceProtection`](https://ej2.syncfusion.com/react/documentation/api/document-editor/editor/#enforceprotection) and [`stopProtection`](https://ej2.syncfusion.com/react/documentation/api/document-editor/editor/#stopprotection) API. +Document editor provides an option to protect and unprotect document using [`enforceProtection`](https://ej2.syncfusion.com/react/documentation/api/document-editor/editor#enforceprotection) and [`stopProtection`](https://ej2.syncfusion.com/react/documentation/api/document-editor/editor#stopprotection) API. The following example code illustrates how to enforce and stop protection in Document editor container. diff --git a/Document-Processing/Word/Word-Processor/vue/images/track-changes-customData.png b/Document-Processing/Word/Word-Processor/vue/images/track-changes-customData.png new file mode 100644 index 000000000..cf1fdff50 Binary files /dev/null and b/Document-Processing/Word/Word-Processor/vue/images/track-changes-customData.png differ diff --git a/Document-Processing/Word/Word-Processor/vue/spell-check.md b/Document-Processing/Word/Word-Processor/vue/spell-check.md index 7597666c5..149ce1832 100644 --- a/Document-Processing/Word/Word-Processor/vue/spell-check.md +++ b/Document-Processing/Word/Word-Processor/vue/spell-check.md @@ -120,6 +120,13 @@ The following code example illustrates how to enable optimized spell checking. ```ts this.container.documentEditor.spellChecker.enableOptimizedSpellCheck = true; ``` +### EnableUserDictionary + +By default, Document Editor maintains a shared custom dictionary for all users. You can enable user-specific dictionary support using the [`enableUserDictionary`](https://ej2.syncfusion.com/vue/documentation/api/document-editor/spellchecker#enableuserdictionary-boolean) API, which stores and retrieves error words based on the `currentUser` property. + +```ts +this.container.documentEditor.spellChecker.enableUserDictionary = true; +``` ### Spell check dictionary cache diff --git a/Document-Processing/Word/Word-Processor/vue/track-changes.md b/Document-Processing/Word/Word-Processor/vue/track-changes.md index 6b6f96514..201d2279a 100644 --- a/Document-Processing/Word/Word-Processor/vue/track-changes.md +++ b/Document-Processing/Word/Word-Processor/vue/track-changes.md @@ -165,6 +165,47 @@ In DocumentEditor, we have built-in review panel in which we have provided suppo ![Track changes](images/track-changes.png) +## Custom metadata along with author + +The Document Editor provides options to customize revisions using [`revisionSettings`](https://ej2.syncfusion.com/vue/documentation/api/document-editor/documenteditorsettingsmodel#revisionsettings). The [`customData`](https://ej2.syncfusion.com/vue/documentation/api/document-editor/revisionsettings#customdata) property allows you to attach additional metadata to tracked revisions in the Word Processor. This metadata can represent roles, tags, or any custom identifier for the revision. To display this metadata along with the author name in the Track Changes pane, you must enable the [`showCustomDataWithAuthor`](https://ej2.syncfusion.com/vue/documentation/api/document-editor/revisionsettings#showcustomdatawithauthor) property. + +The following example code illustrates how to enable and update custom metadata for track changes revisions. + +```ts + + + + +``` +The Track Changes pane will display the author name along with the custom metadata, as shown in the screenshot below. + +![Custom metadata along with author](images/track-changes-customData.png) + +>Note: +* When you export the document as SFDT, the customData value is stored in the revision collection. When you reopen the SFDT, the custom data is automatically restored and displayed in the Track Changes pane. +* Other than SFDT export (e.g. DOCX and other), the customData is not preserved, as it is specific to the Document Editor component. + + ## Protect the document in track changes only mode Document Editor provides support for protecting the document with `RevisionsOnly` protection. In this protection, all the users are allowed to view the document and do their corrections, but they cannot accept or reject any tracked changes in the document. Later, the author can view their corrections and accept or reject the changes. diff --git a/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/track-changes-revisionSettings/document-editor.cs b/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/track-changes-revisionSettings/document-editor.cs new file mode 100644 index 000000000..cca48eedf --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/track-changes-revisionSettings/document-editor.cs @@ -0,0 +1,5 @@ + public ActionResult Default() + { + return View(); + } + diff --git a/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/track-changes-revisionSettings/razor b/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/track-changes-revisionSettings/razor new file mode 100644 index 000000000..a40941262 --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/track-changes-revisionSettings/razor @@ -0,0 +1,4 @@ +@Html.EJS().DocumentEditorContainer("container").EnableTrackChanges(true).DocumentEditorSettings("settings").Render() + diff --git a/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/track-changes-revisionSettings/tagHelper b/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/track-changes-revisionSettings/tagHelper new file mode 100644 index 000000000..222f30f8c --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/track-changes-revisionSettings/tagHelper @@ -0,0 +1,4 @@ + + diff --git a/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/track-changes-revisionSettings/document-editor.cs b/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/track-changes-revisionSettings/document-editor.cs new file mode 100644 index 000000000..cca48eedf --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/track-changes-revisionSettings/document-editor.cs @@ -0,0 +1,5 @@ + public ActionResult Default() + { + return View(); + } + diff --git a/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/track-changes-revisionSettings/razor b/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/track-changes-revisionSettings/razor new file mode 100644 index 000000000..a40941262 --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/track-changes-revisionSettings/razor @@ -0,0 +1,4 @@ +@Html.EJS().DocumentEditorContainer("container").EnableTrackChanges(true).DocumentEditorSettings("settings").Render() + diff --git a/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/track-changes-revisionSettings/tagHelper b/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/track-changes-revisionSettings/tagHelper new file mode 100644 index 000000000..222f30f8c --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/track-changes-revisionSettings/tagHelper @@ -0,0 +1,4 @@ + +