Skip to content

937080: Add Notes for not recommending to modify sfdt content #4144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: hotfix/hotfix-v29.1.33
Choose a base branch
from
Open

937080: Add Notes for not recommending to modify sfdt content #4144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions ej2-asp-core-mvc/document-editor/EJ2_ASP.MVC/import.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ documentation: ug

In Document Editor, the documents are stored in its own format called **Syncfusion Document Text (SFDT)**.

> The **Syncfusion Document Text** (SFDT) format is only used for Syncfusion. The JSON SFDT structure is used in the Document Editor and has a predefined set of keys. Any customization data provided in the SFDT will not be recognized by the Document Editor. So, we strongly advise against making modifications to the SFDT string, as such alterations can lead to scripting issues during the document processing phase.

> If you want to know more about the structure of our SFDT, you can implement various elements in the document and save it in the SFDT format by setting the optimizeSFDT property to false. You can access the optimizeSFDT property as given below: **"documentEditor.documentEditorSettings.optimizeSfdt = false"**.
So, while rendering the elements, the Document Editor will read the values based on the predefined keys in SFDT format, and the values of the unrecognized keys will be ignored. The SFDT structure we use in our document editor is mostly similar to the Docx XML specifications of MS Word.

To know about optimize-sfdt, please refer this [page](../document-editor/how-to/optimize-sfdt).

The following example shows how to open SFDT data in Document Editor.

{% if page.publishingplatform == "aspnet-core" %}
Expand Down
7 changes: 7 additions & 0 deletions ej2-asp-core-mvc/document-editor/EJ2_ASP.NETCORE/import.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ documentation: ug

In Document Editor, the documents are stored in its own format called **Syncfusion Document Text (SFDT)**.

> The **Syncfusion Document Text** (SFDT) format is only used for Syncfusion. The JSON SFDT structure is used in the Document Editor and has a predefined set of keys. Any customization data provided in the SFDT will not be recognized by the Document Editor. So, we strongly advise against making modifications to the SFDT string, as such alterations can lead to scripting issues during the document processing phase.

> If you want to know more about the structure of our SFDT, you can implement various elements in the document and save it in the SFDT format by setting the optimizeSFDT property to false. You can access the optimizeSFDT property as given below: **"documentEditor.documentEditorSettings.optimizeSfdt = false"**.
So, while rendering the elements, the Document Editor will read the values based on the predefined keys in SFDT format, and the values of the unrecognized keys will be ignored. The SFDT structure we use in our document editor is mostly similar to the Docx XML specifications of MS Word.

To know about optimize-sfdt, please refer this [page](../document-editor/how-to/optimize-sfdt).

{% if page.publishingplatform == "aspnet-core" %}

{% tabs %}
Expand Down