974850: Add documentation for custom data API

Document-Processing/Word/Word-Processor/angular/track-changes.md

@@ -105,6 +105,52 @@ 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 {
+  RibbonService,
+  DocumentEditorContainerComponent,
+} from '@syncfusion/ej2-angular-documenteditor';
+import { DocumentEditorContainerModule } from '@syncfusion/ej2-angular-documenteditor';
+@Component({
+  selector: 'app-container',
+  standalone: true,
+  imports: [DocumentEditorContainerModule],
+  providers: [RibbonService],
+  template: `<ejs-documenteditorcontainer #documenteditor_default 
+      serviceUrl="hostUrl" 
+      height="600px" 
+      style="display:block" 
+      [enableTrackChanges]=true
+      [documentEditorSettings]= "Settings" >
+    </ejs-documenteditorcontainer>
+  `,
+})
+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-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.

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.

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
+
+<SfDocumentEditorContainer @ref="container" Height="590px" DocumentEditorSettings="@settings" EnableTrackChanges="true"></SfDocumentEditorContainer> 
+
+@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.

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
 

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, Ribbon } from '@syncfusion/ej2-documenteditor';
+let container: DocumentEditorContainer = new DocumentEditorContainer({ 
+  height: '590px',
+  serviceUrl= hostUrl, 
+  enableTrackChanges=true,
+  documentEditorSettings: {
+    revisionSettings: { customData : "Developer", showCustomDataWithAuthor : true }}
+});
+DocumentEditorContainer.Inject(Ribbon);
+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.

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
+<template>
+    <div id="app">
+      <ejs-documenteditorcontainer ref='documenteditor' :serviceUrl='serviceUrl' :documentEditorSettings='settings' height="590px" id='container' :enableTrackChanges='true' :documentEditorSettings='settings'></ejs-documenteditorcontainer>
+    </div>
+</template>
+<script>
+  import Vue from 'vue';
+  import { DocumentEditorContainerPlugin, DocumentEditorContainerComponent,Ribbon} from '@syncfusion/ej2-vue-documenteditor';
+
+  Vue.use(DocumentEditorContainerPlugin);
+
+  export default {
+    data() {
+      return { serviceUrl:'https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/',
+      settings: { revisionSettings: { customData: 'Developer', showCustomDataWithAuthor: true} }};
+    },
+    provide: {
+      //Inject require modules.
+      DocumentEditorContainer: [Ribbon]
+    }
+  }
+</script>
+
+
+```
+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-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();
+    }
+

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).EnableToolbar(true).DocumentEditorSettings("settings").Render()
+<script>
+    var settings = { revisionSettings: { customData: 'Developer', showCustomDataWithAuthor: true} };
+</script>

Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/track-changes-revisionSettings/tagHelper

@@ -0,0 +1,4 @@
+<ejs-documenteditorcontainer id="container" documentEditorSettings="settings"  height="590px" enableTrackChanges=true></ejs-documenteditorcontainer>
+<script>
+    var settings = { revisionSettings: { customData: 'Developer', showCustomDataWithAuthor: true} };
+</script>

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();
+    }
+

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()
+<script>
+    var settings = { revisionSettings: { customData: 'Developer', showCustomDataWithAuthor: true} };
+</script>

Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/track-changes-revisionSettings/tagHelper

@@ -0,0 +1,4 @@
+<ejs-documenteditorcontainer id="container" documentEditorSettings="settings"  height="590px" enableTrackChanges=true></ejs-documenteditorcontainer>
+<script>
+    var settings = { revisionSettings: { customData: 'Developer', showCustomDataWithAuthor: true} };
+</script>