diff --git a/Document-Processing/Word/Word-Processor/angular/import.md b/Document-Processing/Word/Word-Processor/angular/import.md index 7d86f06a1e..f9794c109a 100644 --- a/Document-Processing/Word/Word-Processor/angular/import.md +++ b/Document-Processing/Word/Word-Processor/angular/import.md @@ -151,6 +151,59 @@ Here's how to handle the server-side action for converting a Word document into To know about server-side action, please refer to this [page](./web-services-overview). +## Opening a document in asynchronous mode + +[Angular DOCX Editor](https://www.syncfusion.com/docx-editor-sdk/angular-docx-editor) supports asynchronous document loading, which can be enabled using the enable property available in the openAsyncSettings API. + +### Properties + +**enable:** Enables or disables asynchronous document loading. +**initialPageLoadCount:** Number of pages to load initially when the document is opened. +**incrementalPageLoadCount:** Number of pages to load incrementally after initial pages load, during the asynchronous document-loading operation. + +The following example shows how to open the document asynchronously in DOCX Editor. + +```typescript +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-root', + standalone: true, + imports: [DocumentEditorContainerModule], + providers: [ToolbarService], + template: ` + + + `, +}) +export class AppComponent implements OnInit { + @ViewChild('documenteditor_default') + public container?: DocumentEditorContainerComponent; + public fontFamilies = { + fontFamilies: ['Algerian', 'Arial', 'Calibri', 'Cambria', 'Windings'], + }; + ngOnInit(): void {} + onCreate() { + this.container.documentEditorSettings.openAsyncSettings.enable = true; + this.container.documentEditorSettings.openAsyncSettings.initialPageLoadCount = 5; + this.container.documentEditorSettings.openAsyncSettings.incrementalPageLoadCount = 3; + } +} +``` + +N> When asynchronous loading is enabled, the document initially opens in read-only mode, allowing users to view the first set of pages while the remaining pages load in the background. During this time, the document can be viewed but cannot be edited or saved. Once loading is complete, editing and saving become available. + ## Compatibility with Microsoft Word Syncfusion® DOCX Editor is a minimal viable Word document viewer/editor product for web applications. As the most compatible Word editor, the product vision is adding valuable feature sets of Microsoft Word, and not to cover 100% feature sets of Microsoft Word desktop application. You can even see the feature sets difference between Microsoft Word desktop and their Word online application. So kindly don't misunderstand this component as a complete replacement for Microsoft Word desktop application and expect 100% feature sets of it. diff --git a/Document-Processing/Word/Word-Processor/asp-net-core/import.md b/Document-Processing/Word/Word-Processor/asp-net-core/import.md index 4a3717a87a..8a823d6689 100644 --- a/Document-Processing/Word/Word-Processor/asp-net-core/import.md +++ b/Document-Processing/Word/Word-Processor/asp-net-core/import.md @@ -99,6 +99,28 @@ internal static FormatType GetFormatType(string format) } ``` +## Opening a document in asynchronous mode + +[ASP.NET Core DOCX Editor](https://www.syncfusion.com/docx-editor-sdk/asp-net-core-docx-editor) (Document Editor) supports asynchronous document loading, which can be enabled using the enable property available in the openAsyncSettings API. + +### Properties + +**enable:** Enables or disables asynchronous document loading. +**initialPageLoadCount:** Number of pages to load initially when the document is opened. +**incrementalPageLoadCount:** Number of pages to load incrementally after initial pages load, during the asynchronous document-loading operation. + +The following example shows how to open the document asynchronously in DOCX Editor. + +{% tabs %} +{% highlight cshtml tabtitle="CSHTML" %} +{% include code-snippet/document-editor/asp-net-core/document-editor-container/async-loading/tagHelper %} +{% endhighlight %} +{% highlight c# tabtitle="Async-loading.cs" %} +{% endhighlight %} +{% endtabs %} + +N> When asynchronous loading is enabled, the document initially opens in read-only mode, allowing users to view the first set of pages while the remaining pages load in the background. During this time, the document can be viewed but cannot be edited or saved. Once loading is complete, editing and saving become available. + ## See Also * [Feature modules](../asp-net-core/feature-module) diff --git a/Document-Processing/Word/Word-Processor/asp-net-mvc/import.md b/Document-Processing/Word/Word-Processor/asp-net-mvc/import.md index a2fa33e13b..f653034283 100644 --- a/Document-Processing/Word/Word-Processor/asp-net-mvc/import.md +++ b/Document-Processing/Word/Word-Processor/asp-net-mvc/import.md @@ -112,6 +112,28 @@ internal static FormatType GetFormatType(string format) } ``` +## Opening a document in asynchronous mode + +[ASP.NET MVC DOCX Editor](https://www.syncfusion.com/docx-editor-sdk/asp-net-mvc-docx-editor) (Document Editor) supports asynchronous document loading, which can be enabled using the enable property available in the openAsyncSettings API. + +### Properties + +**enable:** Enables or disables asynchronous document loading. +**initialPageLoadCount:** Number of pages to load initially when the document is opened. +**incrementalPageLoadCount:** Number of pages to load incrementally after initial pages load, during the asynchronous document-loading operation. + +The following example shows how to open the document asynchronously in DOCX Editor. + +{% tabs %} +{% highlight cshtml tabtitle="CSHTML" %} +{% include code-snippet/document-editor/asp-net-mvc/document-editor-container/async-loading/razor %} +{% endhighlight %} +{% highlight c# tabtitle="Async-loading.cs" %} +{% endhighlight %} +{% endtabs %} + +N> When asynchronous loading is enabled, the document initially opens in read-only mode, allowing users to view the first set of pages while the remaining pages load in the background. During this time, the document can be viewed but cannot be edited or saved. Once loading is complete, editing and saving become available. + ## See Also * [Feature modules](./feature-module) diff --git a/Document-Processing/Word/Word-Processor/blazor/opening-a-document.md b/Document-Processing/Word/Word-Processor/blazor/opening-a-document.md index 59d29c24e0..51d41260b6 100644 --- a/Document-Processing/Word/Word-Processor/blazor/opening-a-document.md +++ b/Document-Processing/Word/Word-Processor/blazor/opening-a-document.md @@ -392,4 +392,44 @@ The following example code illustrates how to use `MetafileImageParsed` event fo return imageStream; } } -``` \ No newline at end of file +``` + +## Opening a document in asynchronous mode + +[Blazor DOCX Editor](https://www.syncfusion.com/docx-editor-sdk/blazor-docx-editor) (Document Editor) supports asynchronous document loading, which can be enabled using the enable property available in the openAsyncSettings API. + +### Properties + +**enable:** Enables or disables asynchronous document loading. +**initialPageLoadCount:** Number of pages to load initially when the document is opened. +**incrementalPageLoadCount:** Number of pages to load incrementally after initial pages load, during the asynchronous document-loading operation. + +The following example shows how to open the document asynchronously in DOCX Editor. + +```csharp +@using Syncfusion.Blazor.DocumentEditor + + + + + +@code { + SfDocumentEditorContainer container; + + DocumentEditorSettingsModel EditorSettings = new DocumentEditorSettingsModel() + { + OpenAsyncSettings = new OpenAsyncSettingsModel() + { + Enable = true, + InitialPageLoadCount = 5, + IncrementalPageLoadCount = 3 + } + }; + public async void OnCreated(object args) + { + SfDocumentEditor editor = container.DocumentEditor; + } +} +``` + +N> When asynchronous loading is enabled, the document initially opens in read-only mode, allowing users to view the first set of pages while the remaining pages load in the background. During this time, the document can be viewed but cannot be edited or saved. Once loading is complete, editing and saving become available. \ No newline at end of file diff --git a/Document-Processing/Word/Word-Processor/javascript-es5/import.md b/Document-Processing/Word/Word-Processor/javascript-es5/import.md index 0ba6014a0a..c2b3185670 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es5/import.md +++ b/Document-Processing/Word/Word-Processor/javascript-es5/import.md @@ -150,6 +150,30 @@ Here's how to handle the server-side action for converting a Word document into To know about server-side action, please refer to this [page](./web-services-overview). +## Opening a document in asynchronous mode + +[JavaScript DOCX Editor](https://www.syncfusion.com/docx-editor-sdk/javascript-docx-editor) (Document Editor) supports asynchronous document loading, which can be enabled using the enable property available in the openAsyncSettings API. + +### Properties + +**enable:** Enables or disables asynchronous document loading. +**initialPageLoadCount:** Number of pages to load initially when the document is opened. +**incrementalPageLoadCount:** Number of pages to load incrementally after initial pages load, during the asynchronous document-loading operation. + +The following example shows how to open the document asynchronously in DOCX Editor. + +```js +var container = new ej.documenteditor.DocumentEditorContainer({ height: "590px" }); +container.serviceUrl = 'https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/'; +ej.documenteditor.DocumentEditorContainer.Inject(ej.documenteditor.Toolbar); +container.documentEditorSettings.openAsyncSettings.enable = true; +container.documentEditorSettings.openAsyncSettings.initialPageLoadCount = 5; +container.documentEditorSettings.openAsyncSettings.incrementalPageLoadCount = 3; +container.appendTo('#container'); +``` + +N> When asynchronous loading is enabled, the document initially opens in read-only mode, allowing users to view the first set of pages while the remaining pages load in the background. During this time, the document can be viewed but cannot be edited or saved. Once loading is complete, editing and saving become available. + ## Compatibility with Microsoft Word Syncfusion® DOCX Editor is a minimal viable Word document viewer/editor product for web applications. As the most compatible Word editor, the product vision is adding valuable feature sets of Microsoft Word, and not to cover 100% feature sets of Microsoft Word desktop application. You can even see the feature sets difference between Microsoft Word desktop and their Word online application. So kindly don't misunderstand this component as a complete replacement for Microsoft Word desktop application and expect 100% feature sets of it. diff --git a/Document-Processing/Word/Word-Processor/javascript-es6/import.md b/Document-Processing/Word/Word-Processor/javascript-es6/import.md index 00665f231e..057ed41b98 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es6/import.md +++ b/Document-Processing/Word/Word-Processor/javascript-es6/import.md @@ -145,6 +145,32 @@ Here's how to handle the server-side action for converting a Word document into To know about server-side action, please refer to this [page](./web-services-overview). +## Opening a document in asynchronous mode + +[TypeScript DOCX Editor](https://www.syncfusion.com/docx-editor-sdk/javascript-docx-editor) (Document Editor) supports asynchronous document loading, which can be enabled using the enable property available in the [openAsyncSettings](https://ej2.syncfusion.com/documentation/api/document-editor/openasyncsettingsmodel) API. + +### Properties + +**enable:** Enables or disables asynchronous document loading. +**initialPageLoadCount:** Number of pages to load initially when the document is opened. +**incrementalPageLoadCount:** Number of pages to load incrementally after initial pages load, during the asynchronous document-loading operation. + +The following example shows how to open the document asynchronously in DOCX Editor. + +```ts +import { DocumentEditorContainer, Toolbar } from '@syncfusion/ej2-documenteditor'; + +let container: DocumentEditorContainer = new DocumentEditorContainer({ height: '590px' }); +container.serviceUrl = 'https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/'; +DocumentEditorContainer.Inject(Toolbar); +container.documentEditorSettings.openAsyncSettings.enable = true; +container.documentEditorSettings.openAsyncSettings.initialPageLoadCount = 5; +container.documentEditorSettings.openAsyncSettings.incrementalPageLoadCount = 3; +container.appendTo('#container'); +``` + +N> When asynchronous loading is enabled, the document initially opens in read-only mode, allowing users to view the first set of pages while the remaining pages load in the background. During this time, the document can be viewed but cannot be edited or saved. Once loading is complete, editing and saving become available. + ## Compatibility with Microsoft Word Syncfusion® DOCX Editor is a minimal viable Word document viewer/editor product for web applications. As the most compatible Word editor, the product vision is adding valuable feature sets of Microsoft Word, and not to cover 100% feature sets of Microsoft Word desktop application. You can even see the feature sets difference between Microsoft Word desktop and their Word online application. So kindly don't misunderstand this component as a complete replacement for Microsoft Word desktop application and expect 100% feature sets of it. diff --git a/Document-Processing/Word/Word-Processor/react/import.md b/Document-Processing/Word/Word-Processor/react/import.md index 7188e2193a..24cd6b85a6 100644 --- a/Document-Processing/Word/Word-Processor/react/import.md +++ b/Document-Processing/Word/Word-Processor/react/import.md @@ -156,6 +156,56 @@ Here's how to handle the server-side action for converting a Word document into To know about server-side action, please refer to this [page](./web-services-overview). +## Opening a document in asynchronous mode + +[React DOCX Editor](https://www.syncfusion.com/docx-editor-sdk/react-docx-editor) (Document Editor) supports asynchronous document loading, which can be enabled using the enable property available in the openAsyncSettings API. + +### Properties + +**enable:** Enables or disables asynchronous document loading. +**initialPageLoadCount:** Number of pages to load initially when the document is opened. +**incrementalPageLoadCount:** Number of pages to load incrementally after initial pages load, during the asynchronous document-loading operation. + +The following example shows how to open the document asynchronously in DOCX Editor. + +```ts +import { createRoot } from 'react-dom/client'; +import './index.css'; +import * as React from 'react'; +import { + DocumentEditorContainerComponent, + Toolbar, +} from '@syncfusion/ej2-react-documenteditor'; +DocumentEditorContainerComponent.Inject(Toolbar); +function App() { + let container = DocumentEditorContainerComponent; + function onCreate() { + container.documentEditorSettings.openAsyncSettings.enable = true; + container.documentEditorSettings.openAsyncSettings.initialPageLoadCount = 5; + container.documentEditorSettings.openAsyncSettings.incrementalPageLoadCount = 3; + } + return ( +
+ { + container = scope; + }} + height={'590px'} + serviceUrl="https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/" + enableToolbar={true} + created={onCreate} + /> +
+ ); +} +export default App; +createRoot(document.getElementById('sample')).render(); + +``` + +N> When asynchronous loading is enabled, the document initially opens in read-only mode, allowing users to view the first set of pages while the remaining pages load in the background. During this time, the document can be viewed but cannot be edited or saved. Once loading is complete, editing and saving become available. + ## Compatibility with Microsoft Word Syncfusion® DOCX Editor is a minimal viable Word document viewer/editor product for web applications. As the most compatible Word editor, the product vision is adding valuable feature sets of Microsoft Word, and not to cover 100% feature sets of Microsoft Word desktop application. You can even see the feature sets difference between Microsoft Word desktop and their Word online application. So kindly don't misunderstand this component as a complete replacement for Microsoft Word desktop application and expect 100% feature sets of it. diff --git a/Document-Processing/Word/Word-Processor/vue/import.md b/Document-Processing/Word/Word-Processor/vue/import.md index 8e205864ed..3bcb2870d5 100644 --- a/Document-Processing/Word/Word-Processor/vue/import.md +++ b/Document-Processing/Word/Word-Processor/vue/import.md @@ -222,6 +222,85 @@ Here's how to handle the server-side action for converting a Word document into To know about server-side action, please refer to this [page](./web-services-overview). +## Opening a document in asynchronous mode + +[Vue DOCX Editor](https://www.syncfusion.com/docx-editor-sdk/vue-docx-editor) (Document Editor) supports asynchronous document loading, which can be enabled using the enable property available in the openAsyncSettings API. + +### Properties + +**enable:** Enables or disables asynchronous document loading. +**initialPageLoadCount:** Number of pages to load initially when the document is opened. +**incrementalPageLoadCount:** Number of pages to load incrementally after initial pages load, during the asynchronous document-loading operation. + +The following example shows how to open the document asynchronously in DOCX Editor. + +{% tabs %} +{% highlight html tabtitle="Composition API (~/src/App.vue)" %} + + + + +{% endhighlight %} +{% highlight html tabtitle="Options API (~/src/App.vue)" %} + + + + +{% endhighlight %} +{% endtabs %} + +N> When asynchronous loading is enabled, the document initially opens in read-only mode, allowing users to view the first set of pages while the remaining pages load in the background. During this time, the document can be viewed but cannot be edited or saved. Once loading is complete, editing and saving become available. + ## Compatibility with Microsoft Word Syncfusion® DOCX Editor is a minimal viable Word document viewer/editor product for web applications. As the most compatible Word editor, the product vision is adding valuable feature sets of Microsoft Word, and not to cover 100% feature sets of Microsoft Word desktop application. You can even see the feature sets difference between Microsoft Word desktop and their Word online application. So kindly don't misunderstand this component as a complete replacement for Microsoft Word desktop application and expect 100% feature sets of it. diff --git a/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/async-loading/razor b/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/async-loading/razor new file mode 100644 index 0000000000..6e331668d2 --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/async-loading/razor @@ -0,0 +1,13 @@ +
+@Html.EJS().DocumentEditorContainer("container").Created("onCreated").EnableToolbar(true).Render() +
+ diff --git a/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/async-loading/tagHelper b/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/async-loading/tagHelper new file mode 100644 index 0000000000..63860db552 --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-core/document-editor-container/async-loading/tagHelper @@ -0,0 +1,14 @@ + + + + + diff --git a/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/async-loading/razor b/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/async-loading/razor new file mode 100644 index 0000000000..a4ed6f33bd --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/async-loading/razor @@ -0,0 +1,14 @@ +
+@Html.EJS().DocumentEditorContainer("container").Created("onCreated").EnableToolbar(true).Render() +
+ diff --git a/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/async-loading/tagHelper b/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/async-loading/tagHelper new file mode 100644 index 0000000000..b2175b2ee3 --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-mvc/document-editor-container/async-loading/tagHelper @@ -0,0 +1,15 @@ + + + + +