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
53 changes: 53 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,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: `
<ejs-documenteditorcontainer #documenteditor_default
serviceUrl="https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/"
height="600px"
style="display:block"
[documentEditorSettings]= "fontFamilies"
(created)="onCreate()"
[enableToolbar]=true >
</ejs-documenteditorcontainer>
`,
})
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<sup style="font-size:70%">&reg;</sup> 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.
Expand Down
22 changes: 22 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 @@ -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)
22 changes: 22 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 @@ -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)
Original file line number Diff line number Diff line change
Expand Up @@ -392,4 +392,44 @@ The following example code illustrates how to use `MetafileImageParsed` event fo
return imageStream;
}
}
```
```

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

<SfDocumentEditorContainer @ref="container" EnableToolbar=true DocumentEditorSettings="EditorSettings">
<DocumentEditorContainerEvents Created="OnCreated"></DocumentEditorContainerEvents>
</SfDocumentEditorContainer>

@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.
24 changes: 24 additions & 0 deletions Document-Processing/Word/Word-Processor/javascript-es5/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<sup style="font-size:70%">&reg;</sup> 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.
Expand Down
26 changes: 26 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,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<sup style="font-size:70%">&reg;</sup> 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.
Expand Down
50 changes: 50 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,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 (
<div>
<DocumentEditorContainerComponent
id="container"
ref={(scope) => {
container = scope;
}}
height={'590px'}
serviceUrl="https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/"
enableToolbar={true}
created={onCreate}
/>
</div>
);
}
export default App;
createRoot(document.getElementById('sample')).render(<App />);

```

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<sup style="font-size:70%">&reg;</sup> 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.
Expand Down
79 changes: 79 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,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)" %}

<template>
<div id="app">
<ejs-documenteditorcontainer ref='container' :serviceUrl='serviceUrl' v-on:created="onCreated" height="590px"
id='container' :enableToolbar='true'></ejs-documenteditorcontainer>
</div>
</template>
<script setup>
import { DocumentEditorContainerComponent as EjsDocumenteditorcontainer, Toolbar } from '@syncfusion/ej2-vue-documenteditor';
import { provide, ref } from 'vue';

const container = ref(null);
const serviceUrl = 'https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/';

//Inject required modules.
provide('DocumentEditorContainer', [Toolbar])

const onCreated = function () {
container.value.ej2Instances.documentEditorSettings.openAsyncSettings.enable = true;
container.value.ej2Instances.documentEditorSettings.openAsyncSettings.initialPageLoadCount = 5;
container.value.ej2Instances.documentEditorSettings.openAsyncSettings.incrementalPageLoadCount = 3;
}
</script>

{% endhighlight %}
{% highlight html tabtitle="Options API (~/src/App.vue)" %}

<template>
<div id="app">
<ejs-documenteditorcontainer ref='container' :serviceUrl='serviceUrl' v-on:created="onCreated" height="590px"
id='container' :enableToolbar='true'></ejs-documenteditorcontainer>
</div>
</template>
<script>
import { DocumentEditorContainerComponent, Toolbar } from '@syncfusion/ej2-vue-documenteditor';

export default {
components: {
'ejs-documenteditorcontainer': DocumentEditorContainerComponent
},
data() {
return {
serviceUrl:
'https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/',
};
},
provide: {
//Inject required modules.
DocumentEditorContainer: [Toolbar]
},
methods: {
onCreated: function () {
this.$refs.container.ej2Instances.documentEditorSettings.openAsyncSettings.enable = true;
this.$refs.container.ej2Instances.documentEditorSettings.openAsyncSettings.initialPageLoadCount = 5;
this.$refs.container.ej2Instances.documentEditorSettings.openAsyncSettings.incrementalPageLoadCount = 3;
},
},
};
</script>

{% 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<sup style="font-size:70%">&reg;</sup> 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.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<div>
@Html.EJS().DocumentEditorContainer("container").Created("onCreated").EnableToolbar(true).Render()
</div>
<script>
var container;
function onCreated() {
var documenteditorElement = document.getElementById("container");
container = documenteditorElement.ej2_instances[0];
container.documentEditorSettings.openAsyncSettings.enable = true;
container.documentEditorSettings.openAsyncSettings.initialPageLoadCount = 5;
container.documentEditorSettings.openAsyncSettings.incrementalPageLoadCount = 3;
}
</script>
Loading