Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
44 changes: 44 additions & 0 deletions Document-Processing/Word/Word-Processor/angular/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: `<ejs-documenteditorcontainer #documenteditor_default
serviceUrl="HostUrl"
height="600px"
style="display:block"
[documentEditorSettings]= "Settings">
</ejs-documenteditorcontainer>
`,
})
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<sup style="font-size:70%">&reg;</sup> 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.
Expand Down
20 changes: 20 additions & 0 deletions Document-Processing/Word/Word-Processor/asp-net-core/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
20 changes: 20 additions & 0 deletions Document-Processing/Word/Word-Processor/asp-net-mvc/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -392,4 +392,28 @@ The following example code illustrates how to use `MetafileImageParsed` event fo
return imageStream;
}
}
```
```

## 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

<SfDocumentEditorContainer @ref="container" Height="590px" DocumentEditorSettings="@settings">
</SfDocumentEditorContainer>

@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.
27 changes: 27 additions & 0 deletions Document-Processing/Word/Word-Processor/javascript-es5/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<sup style="font-size:70%">&reg;</sup> 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.
Expand Down
29 changes: 29 additions & 0 deletions Document-Processing/Word/Word-Processor/javascript-es6/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<sup style="font-size:70%">&reg;</sup> 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.
Expand Down
44 changes: 44 additions & 0 deletions Document-Processing/Word/Word-Processor/react/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
<DocumentEditorContainerComponent
id="container"
ref={(scope) => {
container = scope;
}}
height={'590px'}
serviceUrl="HostUrl"
documentEditorSettings={settings}/>
);
}
export default App;
ReactDOM.render(<App />, 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<sup style="font-size:70%">&reg;</sup> 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.
Expand Down
42 changes: 42 additions & 0 deletions Document-Processing/Word/Word-Processor/vue/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

```
<template>
<div id="app">
<ejs-documenteditorcontainer ref='documenteditor' :serviceUrl='serviceUrl' :documentEditorSettings='settings' height="590px" id='container'></ejs-documenteditorcontainer>
</div>
</template>
<script>
import Vue from 'vue';
import { DocumentEditorContainerPlugin, DocumentEditorContainerComponent,Toolbar} from '@syncfusion/ej2-vue-documenteditor';

Vue.use(DocumentEditorContainerPlugin);

export default {
data() {
return { serviceUrl:'HostUrl'},
settings: {
openAsyncSettings: {
enable: true, // Enable async (lazy) loading
initialPageLoadCount: 5, // Render first 5 pages immediately
incrementalPageLoadCount: 3 // Load 3 pages per background batch
}
};
},
provide: {
//Inject require modules.
DocumentEditorContainer: [Toolbar]
}
}
</script>
```
>Note: Users can view the pages already loaded, but all other interactions remain restricted until all pages finish loading.

## Compatibility with Microsoft Word

Syncfusion<sup style="font-size:70%">&reg;</sup> 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.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
public ActionResult Default()
{
return View();
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
@Html.EJS().DocumentEditorContainer("container").DocumentEditorSettings("settings").Render()
<script>
var settings = {
openAsyncSettings: {
enable: true, // Enable async (lazy) loading
initialPageLoadCount: 5, // Render first 5 pages immediately
incrementalPageLoadCount: 3 // Load 3 pages per background batch
}
};
</script>
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<ejs-documenteditorcontainer id="container" documentEditorSettings="settings" height="590px"></ejs-documenteditorcontainer>

<script>
var settings = {
openAsyncSettings: {
enable: true, // Enable async (lazy) loading
initialPageLoadCount: 5, // Render first 5 pages immediately
incrementalPageLoadCount: 3 // Load 3 pages per background batch
}
};
</script>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
public ActionResult Default()
{
return View();
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
@Html.EJS().DocumentEditorContainer("container").DocumentEditorSettings("settings").Render()
<script>
var settings = {
openAsyncSettings: {
enable: true, // Enable async (lazy) loading
initialPageLoadCount: 5, // Render first 5 pages immediately
incrementalPageLoadCount: 3 // Load 3 pages per background batch
}
};
</script>
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<ejs-documenteditorcontainer id="container" documentEditorSettings="settings" height="590px"></ejs-documenteditorcontainer>

<script>
var settings = {
openAsyncSettings: {
enable: true, // Enable async (lazy) loading
initialPageLoadCount: 5, // Render first 5 pages immediately
incrementalPageLoadCount: 3 // Load 3 pages per background batch
}
};
</script>