diff --git a/Document-Processing/Word/Word-Processor/angular/import.md b/Document-Processing/Word/Word-Processor/angular/import.md index be6bd7002..eea7cbed2 100644 --- a/Document-Processing/Word/Word-Processor/angular/import.md +++ b/Document-Processing/Word/Word-Processor/angular/import.md @@ -151,6 +151,50 @@ Here’s how to handle the server-side action for converting word document in to To know about server-side action, please refer this [page](./web-services-overview). +## Load documents asynchronously + +Document Editor provides an option to load a document asynchronously using the [`openAsyncSettings`](https://ej2.syncfusion.com/angular/documentation/api/document-editor/openasyncsettings) property. + +* [`enable`](https://ej2.syncfusion.com/angular/documentation/api/document-editor/openasyncsettings#enable) - Enables or disables async loading. +* [`initialPageLoadCount`](https://ej2.syncfusion.com/angular/documentation/api/document-editor/openasyncsettings#initialpageloadcount) - Defines the number of pages rendered immediately when the document opens. +* [`incrementalPageLoadCount`](https://ej2.syncfusion.com/angular/documentation/api/document-editor/openasyncsettings#incrementalpageloadcount) - Specifies how many pages load in each background batch after the initial set. + +The following code shows the how to enable the asynchronous loading in Document Editor. + +```csharp +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 = { + openAsyncSettings: { + enable: true, // Enable async (lazy) loading + initialPageLoadCount: 5, // Render first 5 pages immediately + incrementalPageLoadCount: 3 // Load 3 pages per background batch + } + }; ngOnInit(): void {} +} +``` +>Note: Users can view the pages already loaded, but all other interactions remain restricted until all pages finish loading. + ## Compatibility with Microsoft Word Syncfusion® Document Editor is a minimal viable Word document viewer/editor product for web applications. As 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 f0fc526f4..26cfb74e1 100644 --- a/Document-Processing/Word/Word-Processor/asp-net-core/import.md +++ b/Document-Processing/Word/Word-Processor/asp-net-core/import.md @@ -98,6 +98,26 @@ internal static FormatType GetFormatType(string format) } } ``` +## Load documents asynchronously + +Document Editor provides an option to load a document asynchronously using the [`openAsyncSettings`] property. + +* [`enable`] - Enables or disables async loading. +* [`initialPageLoadCount`] - Defines the number of pages rendered immediately when the document opens. +* [`incrementalPageLoadCount`] - Specifies how many pages load in each background batch after the initial set. + +The following code shows the how to enable the asynchronous loading in Document Editor. + +{% tabs %} +{% highlight cshtml tabtitle="CSHTML" %} +{% include code-snippet/document-editor/asp-net-core/import-async/tagHelper %} +{% endhighlight %} +{% highlight c# tabtitle="Document-editor.cs" %} +{% include code-snippet/document-editor/asp-net-core/import-async/document-editor.cs %} +{% endhighlight %} +{% endtabs %} + +>Note: Users can view the pages already loaded, but all other interactions remain restricted until all pages finish loading. ## See Also 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 c5e6c815c..92b05ab3c 100644 --- a/Document-Processing/Word/Word-Processor/asp-net-mvc/import.md +++ b/Document-Processing/Word/Word-Processor/asp-net-mvc/import.md @@ -111,6 +111,26 @@ internal static FormatType GetFormatType(string format) } } ``` +## Load documents asynchronously + +Document Editor provides an option to load a document asynchronously using the [`openAsyncSettings`] property. + +* [`enable`] - Enables or disables async loading. +* [`initialPageLoadCount`] - Defines the number of pages rendered immediately when the document opens. +* [`incrementalPageLoadCount`] - Specifies how many pages load in each background batch after the initial set. + +The following code shows the how to enable the asynchronous loading in Document Editor. + +{% tabs %} +{% highlight razor tabtitle="CSHTML" %} +{% include code-snippet/document-editor/asp-net-mvc/import-async/razor %} +{% endhighlight %} +{% highlight c# tabtitle="Document-editor.cs" %} +{% include code-snippet/document-editor/asp-net-mvc/import-async/document-editor.cs %} +{% endhighlight %} +{% endtabs %} + +>Note: Users can view the pages already loaded, but all other interactions remain restricted until all pages finish loading. ## See Also 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 9bd9b7c0c..60b2181a1 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,28 @@ The following example code illustrates how to use `MetafileImageParsed` event fo return imageStream; } } -``` \ No newline at end of file +``` + +## Load documents asynchronously + +Document Editor provides an option to load a document asynchronously using the [`OpenAsyncSettings`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DocumentEditor.OpenAsyncSettingsModel.html) property. + +* [`Enable`] - Enables or disables async loading. +* [`InitialPageLoadCount`] - Defines the number of pages rendered immediately when the document opens. +* [`IncrementalPageLoadCount`] - Specifies how many pages load in each background batch after the initial set. + +The following code shows the how to enable the asynchronous loading in Document Editor. + +```cshtml +@using Syncfusion.Blazor.DocumentEditor + + + + +@code { + SfDocumentEditorContainer container; + DocumentEditorSettingsModel settings = new DocumentEditorSettingsModel() { OpenAsyncSettings = { Enable = true, InitialPageLoadCount = 5, IncrementalPageLoadCount= 3 }}; + +} +``` +>Note: Users can view the pages already loaded, but all other interactions remain restricted until all pages finish loading. \ 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 31f3c9b1d..784d5a647 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es5/import.md +++ b/Document-Processing/Word/Word-Processor/javascript-es5/import.md @@ -141,6 +141,33 @@ Here’s how to handle the server-side action for converting word document in to To know about server-side action, please refer this [page](./web-services-overview). +## Load documents asynchronously + +Document Editor provides an option to load a document asynchronously using the [`openAsyncSettings`](https://ej2.syncfusion.com/javascript/documentation/api/document-editor/openasyncsettings) property. + +* [`enable`](https://ej2.syncfusion.com/javascript/documentation/api/document-editor/openasyncsettings#enable) - Enables or disables async loading. +* [`initialPageLoadCount`](https://ej2.syncfusion.com/javascript/documentation/api/document-editor/openasyncsettings#initialpageloadcount) - Defines the number of pages rendered immediately when the document opens. +* [`incrementalPageLoadCount`](https://ej2.syncfusion.com/javascript/documentation/api/document-editor/openasyncsettings#incrementalpageloadcount) - Specifies how many pages load in each background batch after the initial set. + +The following code shows the how to enable the asynchronous loading in Document Editor. + +```c# +var container = new ej.documenteditor.DocumentEditor({serviceUrl: HostUrl, + height: '590px', + documentEditorSettings: { + openAsyncSettings: { + enable: true, // Enable async (lazy) loading + initialPageLoadCount: 5, // Render first 5 pages immediately + incrementalPageLoadCount: 3 // Load 3 pages per background batch + } + } + }); +DocumentEditorContainer.Inject(Toolbar); +container.appendTo('#container'); + +``` +>Note: Users can view the pages already loaded, but all other interactions remain restricted until all pages finish loading. + ## Compatibility with Microsoft Word Syncfusion® Document Editor is a minimal viable Word document viewer/editor product for web applications. As 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 40b2eab58..ffb3b1966 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es6/import.md +++ b/Document-Processing/Word/Word-Processor/javascript-es6/import.md @@ -145,6 +145,35 @@ Here’s how to handle the server-side action for converting word document in to To know about server-side action, please refer this [page](./web-services-overview). +## Load documents asynchronously + +Document Editor provides an option to load a document asynchronously using the [`openAsyncSettings`](https://ej2.syncfusion.com/documentation/api/document-editor/openasyncsettings) property. + +* [`enable`](https://ej2.syncfusion.com/documentation/api/document-editor/openasyncsettings#enable) - Enables or disables async loading. +* [`initialPageLoadCount`](https://ej2.syncfusion.com/documentation/api/document-editor/openasyncsettings#initialpageloadcount) - Defines the number of pages rendered immediately when the document opens. +* [`incrementalPageLoadCount`](https://ej2.syncfusion.com/documentation/api/document-editor/openasyncsettings#incrementalpageloadcount) - Specifies how many pages load in each background batch after the initial set. + +The following code shows the how to enable the asynchronous loading in Document Editor. + +```c# +let container: DocumentEditorContainer = new DocumentEditorContainer({ + height: '590px', + documentEditorSettings: { + openAsyncSettings: { + enable: true, // Enable async (lazy) loading + initialPageLoadCount: 5, // Render first 5 pages immediately + incrementalPageLoadCount: 3 // Load 3 pages per background batch + } + } + }); +DocumentEditorContainer.Inject(Toolbar); +container.serviceUrl = 'HostUrl'; +container.appendTo('#container'); + + +``` +>Note: Users can view the pages already loaded, but all other interactions remain restricted until all pages finish loading. + ## Compatibility with Microsoft Word Syncfusion® Document Editor is a minimal viable Word document viewer/editor product for web applications. As 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 c871032b4..728810e44 100644 --- a/Document-Processing/Word/Word-Processor/react/import.md +++ b/Document-Processing/Word/Word-Processor/react/import.md @@ -156,6 +156,50 @@ Here’s how to handle the server-side action for converting word document in to To know about server-side action, please refer this [page](./web-services-overview). +## Load documents asynchronously + +Document Editor provides an option to load a document asynchronously using the [`openAsyncSettings`](https://ej2.syncfusion.com/react/documentation/api/document-editor/openasyncsettings) property. + +* [`enable`](https://ej2.syncfusion.com/react/documentation/api/document-editor/openasyncsettings#enable) - Enables or disables async loading. +* [`initialPageLoadCount`](https://ej2.syncfusion.com/react/documentation/api/document-editor/openasyncsettings#initialpageloadcount) - Defines the number of pages rendered immediately when the document opens. +* [`incrementalPageLoadCount`](https://ej2.syncfusion.com/react/documentation/api/document-editor/openasyncsettings#incrementalpageloadcount) - Specifies how many pages load in each background batch after the initial set. + +The following code shows the how to enable the asynchronous loading in Document Editor. + +```csharp +import * as ReactDOM from 'react-dom'; +import * as React from 'react'; +import { + DocumentEditorContainerComponent, + Toolbar, +} from '@syncfusion/ej2-react-documenteditor'; + +DocumentEditorContainerComponent.Inject(Toolbar); +function App() { + let container; + let settings = { + openAsyncSettings: { + enable: true, // Enable async (lazy) loading + initialPageLoadCount: 5, // Render first 5 pages immediately + incrementalPageLoadCount: 3 // Load 3 pages per background batch + } + }; + return ( + { + container = scope; + }} + height={'590px'} + serviceUrl="HostUrl" + documentEditorSettings={settings}/> + ); +} +export default App; +ReactDOM.render(, document.getElementById('sample')); +``` +>Note: Users can view the pages already loaded, but all other interactions remain restricted until all pages finish loading. + ## Compatibility with Microsoft Word Syncfusion® Document Editor is a minimal viable Word document viewer/editor product for web applications. As 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 7835331a2..5f91563c8 100644 --- a/Document-Processing/Word/Word-Processor/vue/import.md +++ b/Document-Processing/Word/Word-Processor/vue/import.md @@ -222,6 +222,48 @@ Here’s how to handle the server-side action for converting word document in to To know about server-side action, please refer this [page](./web-services-overview). +## Load documents asynchronously + +Document Editor provides an option to load a document asynchronously using the [`openAsyncSettings`](https://ej2.syncfusion.com/vue/documentation/api/document-editor/openasyncsettings) property. + +* [`enable`](https://ej2.syncfusion.com/vue/documentation/api/document-editor/openasyncsettings#enable) - Enables or disables async loading. +* [`initialPageLoadCount`](https://ej2.syncfusion.com/vue/documentation/api/document-editor/openasyncsettings#initialpageloadcount) - Defines the number of pages rendered immediately when the document opens. +* [`incrementalPageLoadCount`](https://ej2.syncfusion.com/vue/documentation/api/document-editor/openasyncsettings#incrementalpageloadcount) - Specifies how many pages load in each background batch after the initial set. + +The following code shows the how to enable the asynchronous loading in Document Editor. + +``` + + +``` +>Note: Users can view the pages already loaded, but all other interactions remain restricted until all pages finish loading. + ## Compatibility with Microsoft Word Syncfusion® Document Editor is a minimal viable Word document viewer/editor product for web applications. As 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/import-async/document-editor.cs b/Document-Processing/code-snippet/document-editor/asp-net-core/import-async/document-editor.cs new file mode 100644 index 000000000..048a3eb88 --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-core/import-async/document-editor.cs @@ -0,0 +1,5 @@ +public ActionResult Default() +{ + return View(); +} + diff --git a/Document-Processing/code-snippet/document-editor/asp-net-core/import-async/razor b/Document-Processing/code-snippet/document-editor/asp-net-core/import-async/razor new file mode 100644 index 000000000..6e7cbe90c --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-core/import-async/razor @@ -0,0 +1,10 @@ +@Html.EJS().DocumentEditorContainer("container").DocumentEditorSettings("settings").Render() + diff --git a/Document-Processing/code-snippet/document-editor/asp-net-core/import-async/tagHelper b/Document-Processing/code-snippet/document-editor/asp-net-core/import-async/tagHelper new file mode 100644 index 000000000..67a154ef7 --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-core/import-async/tagHelper @@ -0,0 +1,11 @@ + + + diff --git a/Document-Processing/code-snippet/document-editor/asp-net-mvc/import-async/document-editor.cs b/Document-Processing/code-snippet/document-editor/asp-net-mvc/import-async/document-editor.cs new file mode 100644 index 000000000..048a3eb88 --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-mvc/import-async/document-editor.cs @@ -0,0 +1,5 @@ +public ActionResult Default() +{ + return View(); +} + diff --git a/Document-Processing/code-snippet/document-editor/asp-net-mvc/import-async/razor b/Document-Processing/code-snippet/document-editor/asp-net-mvc/import-async/razor new file mode 100644 index 000000000..6e7cbe90c --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-mvc/import-async/razor @@ -0,0 +1,10 @@ +@Html.EJS().DocumentEditorContainer("container").DocumentEditorSettings("settings").Render() + diff --git a/Document-Processing/code-snippet/document-editor/asp-net-mvc/import-async/tagHelper b/Document-Processing/code-snippet/document-editor/asp-net-mvc/import-async/tagHelper new file mode 100644 index 000000000..67a154ef7 --- /dev/null +++ b/Document-Processing/code-snippet/document-editor/asp-net-mvc/import-async/tagHelper @@ -0,0 +1,11 @@ + + +