diff --git a/Document-Processing/Word/Word-Processor/vue/troubleshooting/document-loading-issue-with-404-error.md b/Document-Processing/Word/Word-Processor/vue/troubleshooting/document-loading-issue-with-404-error.md index acb366a1fa..fbeb77f644 100644 --- a/Document-Processing/Word/Word-Processor/vue/troubleshooting/document-loading-issue-with-404-error.md +++ b/Document-Processing/Word/Word-Processor/vue/troubleshooting/document-loading-issue-with-404-error.md @@ -16,9 +16,9 @@ If document loading fails and you see a 404 error in the browser console, the [V The 404 error may occur due to the following reasons: -- **The Web Service is not running or inactive** – When hosting your own Web API, the server may be stopped or not deployed correctly, causing required endpoints such as `/Import` or `/SpellCheck` to return 404. -- **The configured `serviceUrl` is invalid** – Issues like a missing trailing slash (`/`), wrong port number, incorrect API route, or typos will cause the editor to call incorrect endpoints. -- **The application is using an old or discontinued Document Editor service URL** – When using an old Document Editor service URL which no longer valid. +- **The Web Service is not running or inactive** – When hosting your own Web Service, the server may be stopped, not deployed correctly, or configured such that required endpoints (e.g., `/Import`, `/SpellCheck`) return 404. +- **The configured `serviceUrl` is invalid** – A missing trailing slash (`/`), wrong port, incorrect API route, or typos cause the editor to call invalid endpoints. +- **The application is using an old or discontinued Document Editor service URL** – When using an old Document Editor service URL that is no longer valid. ## Solutions @@ -28,6 +28,6 @@ The 404 error may occur due to the following reasons: container.serviceUrl = 'https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/'; ``` -> Note: The hosted Web API link is provided for demonstration and evaluation only. For production deployment, please host your own web service with your required server configurations. You can refer and reuse the [GitHub Web Service example](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices) or [Docker image](https://hub.docker.com/r/syncfusion/word-processor-server) for hosting your own web service and use for the serviceUrl property. +N> The hosted Web Service link is provided for demonstration and evaluation only. For production deployment, please host your own Web Service with your required server configurations. You can refer and reuse the [GitHub Web Service example](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices) or [Docker image](https://hub.docker.com/r/syncfusion/word-processor-server) for hosting your own Web Service and use it for the serviceUrl property. - If you are using your own hosted Web API, ensure that the Web Service is running, active, and the configured service URL is valid. \ No newline at end of file diff --git a/Document-Processing/Word/Word-Processor/vue/web-services-overview.md b/Document-Processing/Word/Word-Processor/vue/web-services-overview.md index 6e9efa970c..0ecfa7fb45 100644 --- a/Document-Processing/Word/Word-Processor/vue/web-services-overview.md +++ b/Document-Processing/Word/Word-Processor/vue/web-services-overview.md @@ -10,7 +10,7 @@ domainurl: ##DomainURL## # Web services in Vue Document editor component -You can deploy web APIs for server-side dependencies of [Vue DOCX Editor](https://www.syncfusion.com/docx-editor-sdk/vue-docx-editor) (Document Editor) component in the following platforms. +You can deploy web APIs for the server-side dependencies of [Vue DOCX Editor](https://www.syncfusion.com/docx-editor-sdk/vue-docx-editor) (Document Editor) component on the following platforms. * [ASP.NET Core](./web-services/core) * [ASP.NET MVC](./web-services/mvc) @@ -24,12 +24,12 @@ You can deploy web APIs for server-side dependencies of [Vue DOCX Editor](https: |[Paste with formatting](./clipboard#paste-with-formatting)|When pasting the formatted content (HTML/RTF) received from system clipboard. For converting HTML/RTF to SFDT format.

**Note**: Whereas plain text received from system clipboard will be pasted directly in the client-side.|**Client**: Sends the input Html or Rtf string.
**Server**: Receives the input Html or Rtf string and sends the converted SFDT back to the client.| |[Restrict editing](./restrict-editing)|When protecting the document, for generating hash.|**Client**: Sends the input data for hashing algorithm.
**Server**: Receives the input data for hashing algorithm and sends the result hash information back to the client.| |[Spellcheck](./spell-check)(default)|When the spellchecker is enabled on client-side Document Editor, and it performs the spell check validation for words in the document.|**Client**: Sends the words (string) with their language for spelling validation.
**Server**: Receives the words (string) with their language for spelling validation and sends the validation result as JSON back to the client.| -|[SpellCheckByPage](./spell-check)|Document editor provides options to spellcheck page by page when loading the documents. By [enabling optimized spell check](./spell-check#enableoptimizedspellcheck) in client-side, you can perform spellcheck page by page when loading the documents.|**Client**: Sends the words (string) with their language for spelling validation.
**Server**: Receives the words (string) with their language for spelling validation and sends the validation result as JSON back to the client.| +|[SpellCheckByPage](./spell-check)|Document Editor provides options to spellcheck page by page when loading the documents. By [enabling optimized spell check](./spell-check#enableoptimizedspellcheck) in client-side, you can perform spellcheck page by page when loading the documents.|**Client**: Sends the words (string) with their language for spelling validation.
**Server**: Receives the words (string) with their language for spelling validation and sends the validation result as JSON back to the client.| |[Save as file formats other than SFDT and DOCX](./saving-documents/server-side-export) (optional API)|You can configure this API, if you want to save the document in file format other than DOCX and SFDT.

For saving the files as WordML, DOC, RTF, HTML, ODT, Text using Word library (DocIO) and PDF using Word (DocIO) and PDF libraries.|You can transfer document from client to server either as SFDT or DOCX format.

First option (SFDT):
**Client**: Sends the SFDT.
**Server**: Receives the SFDT and saves the converted document as any file format supported by [Word library (DocIO)](https://www.syncfusion.com/word-framework/net/word-library) in server or sends the saved file to the client browser.

Second option (DOCX):
**Client**: Sends the DOCX file.
**Server**: Receives the DOCX file and saves the converted document as any file format supported by [Word library (DocIO)](https://www.syncfusion.com/word-framework/net/word-library) in server or sends the saved file to the client browser.| ->Note: If you don't require the above functionalities then you can deploy as pure client-side component without any server-side interactions. +N> If you don't require the above functionalities, you can deploy the component as a pure client-side solution without any server-side interactions. -Please refer the [example from GitHub](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices) to configure the web service and set the [serviceUrl](https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/). +Please refer to the [example from GitHub](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices) to configure the web service and set the [serviceUrl](https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/). If your running web service Url is `http://localhost:62869/`, set the serviceUrl like below: @@ -39,7 +39,7 @@ this.$refs.container.serviceUrl = "http://localhost:62869/api/documenteditor/"; ## Required Web API structure -Please check below table for expected web API structure. +Please check the table below for the expected web API structure. |Expected method name |Parameters |Return type | |-----|----|----| @@ -54,7 +54,7 @@ Please check below table for expected web API structure. ## Customize the expected method name -Document editor component provides an option to customize the expected method name for Import, SystemClipboard, RestrictEditing and SpellCheck using [serverActionSettings](https://ej2.syncfusion.com/vue/documentation/api/document-editor-container/documentEditorContainerModel#serveractionsettings). +Document Editor component provides an option to customize the expected method name for Import, SystemClipboard, RestrictEditing and SpellCheck using [serverActionSettings](https://ej2.syncfusion.com/vue/documentation/api/document-editor-container/documentEditorContainerModel#serveractionsettings). The following example code illustrates how to customize the method name using serverActionSettings. @@ -114,9 +114,9 @@ export default { > The Web API hosted link `https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/` utilized in the Document Editor's serviceUrl property is intended solely for demonstration and evaluation purposes. For production deployment, please host your own web service with your required server configurations. You can refer and reuse the [GitHub Web Service example](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices) or [Docker image](https://hub.docker.com/r/syncfusion/word-processor-server) for hosting your own web service and use for the serviceUrl property. -## Add the custom headers to XMLHttpRequest +## Add custom headers to XMLHttpRequest -Document editor component provides an an option to add custom headers of XMLHttpRequest using the [`headers`](https://ej2.syncfusion.com/vue/documentation/api/document-editor-container/documentEditorContainerModel#headers). +Document Editor component provides an option to add custom headers to the XMLHttpRequest using the [`headers`](https://ej2.syncfusion.com/vue/documentation/api/document-editor-container/documentEditorContainerModel#headers). {% tabs %} {% highlight html tabtitle="Composition API (~/src/App.vue)" %} @@ -175,9 +175,9 @@ export default { > The Web API hosted link `https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/` utilized in the Document Editor's serviceUrl property is intended solely for demonstration and evaluation purposes. For production deployment, please host your own web service with your required server configurations. You can refer and reuse the [GitHub Web Service example](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices) or [Docker image](https://hub.docker.com/r/syncfusion/word-processor-server) for hosting your own web service and use for the serviceUrl property. -## Modify the XMLHttpRequest before request send +## Modify the XMLHttpRequest before sending the request -Document editor component provides an option to modify the XMLHttpRequest object (setting additional headers, if needed) using [`beforeXmlHttpRequestSend`](https://ej2.syncfusion.com/vue/documentation/api/document-editor-container#beforexmlhttprequestsend) event and it gets triggered before a server request. +Document Editor component provides an option to modify the XMLHttpRequest object (setting additional headers, if needed) using the [`beforeXmlHttpRequestSend`](https://ej2.syncfusion.com/vue/documentation/api/document-editor-container#beforexmlhttprequestsend) event, which gets triggered before a server request. You can customize the required [`XMLHttpRequest`](https://ej2.syncfusion.com/vue/documentation/api/document-editor/xmlHttpRequestEventArgs) properties. @@ -204,7 +204,7 @@ provide('DocumentEditorContainer', [Toolbar]); onMounted(function () { //Here, modifying the request headers container.value.headers = [{ syncfusion: 'true' }]; - // Below action, cancel all server-side interactions expect spell check + // Below action, cancel all server-side interactions except spell check container.value.beforeXmlHttpRequestSend = ( args) => { args.headers = container.value.headers; @@ -242,7 +242,7 @@ onMounted(function () { DocumentEditorContainer: [Toolbar] }, mounted(){ - // Below action, cancel all server-side interactions expect spell check + // Below action, cancel all server-side interactions except spell check this.$refs.container.beforeXmlHttpRequestSend = ( args ) => { //Here, modifying the request headers @@ -265,4 +265,4 @@ onMounted(function () { > The Web API hosted link `https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/` utilized in the Document Editor's serviceUrl property is intended solely for demonstration and evaluation purposes. For production deployment, please host your own web service with your required server configurations. You can refer and reuse the [GitHub Web Service example](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices) or [Docker image](https://hub.docker.com/r/syncfusion/word-processor-server) for hosting your own web service and use for the serviceUrl property. -Note: Find the customizable serverActionType values are `'Import' | 'RestrictEditing' | 'SpellCheck' | 'SystemClipboard'`. \ No newline at end of file +N> The customizable serverActionType values are `'Import' | 'RestrictEditing' | 'SpellCheck' | 'SystemClipboard'`. \ No newline at end of file diff --git a/Document-Processing/Word/Word-Processor/vue/web-services/core.md b/Document-Processing/Word/Word-Processor/vue/web-services/core.md index 8cb2b0cdba..3387bec5fc 100644 --- a/Document-Processing/Word/Word-Processor/vue/web-services/core.md +++ b/Document-Processing/Word/Word-Processor/vue/web-services/core.md @@ -10,7 +10,7 @@ domainurl: ##DomainURL## # Core in Vue Document editor component -DocumentEditor depends on server side interaction for below listed operations can be written in ASP.NET Core using [Syncfusion.EJ2.WordEditor.AspNet.Core](https://www.nuget.org/packages/Syncfusion.EJ2.WordEditor.AspNet.Core). +DocumentEditor depends on server-side interactions for the operations listed below, which can be written in ASP.NET Core using [Syncfusion.EJ2.WordEditor.AspNet.Core](https://www.nuget.org/packages/Syncfusion.EJ2.WordEditor.AspNet.Core). * Import Word Document * Paste with formatting @@ -18,15 +18,15 @@ DocumentEditor depends on server side interaction for below listed operations ca * Spell Check * Save as file formats other than SFDT and DOCX ->Note: Syncfusion® provides a predefined [Word Processor server docker image](https://hub.docker.com/r/syncfusion/word-processor-server) targeting ASP.NET Core 2.1 framework. You can directly pull this docker image and deploy it in server on the go. You can also create own docker image by customizing the existing [docker project from GitHub](https://github.com/SyncfusionExamples/Word-Processor-Server-Docker). To know more, refer this link.[Word Processor Server Docker Image Overview](../server-deployment/word-processor-server-docker-image-overview) +N> Syncfusion® provides a predefined [Word Processor server docker image](https://hub.docker.com/r/syncfusion/word-processor-server) targeting ASP.NET Core 2.1 framework. You can directly pull this docker image and deploy it on a server on the go. You can also create your own docker image by customizing the existing [docker project from GitHub](https://github.com/SyncfusionExamples/Word-Processor-Server-Docker). To know more, refer to this link: [Word Processor Server Docker Image Overview](../server-deployment/word-processor-server-docker-image-overview) This section explains how to create the service for DocumentEditor in ASP.NET Core. -## Importing Word Document +## Importing Word Documents -As the Document editor client-side script requires the document in SFDT file format, you can convert the Word documents (.dotx,.docx,.docm,.dot,.doc), rich text format documents (.rtf), and text documents (.txt) into SFDT format by using this Web API. +As the Document Editor client-side script requires the document in SFDT file format, you can convert the Word documents (.dotx,.docx,.docm,.dot,.doc), rich text format documents (.rtf), and text documents (.txt) into SFDT format by using this Web API. -The following example code illustrates how to write a Web API for importing Word documents into Document Editor component. +The following example code illustrates how to write a Web API for importing Word documents into the Document Editor component. ```c# [AcceptVerbs("Post")] @@ -52,13 +52,13 @@ The following example code illustrates how to write a Web API for importing Word } ``` -### Import document with TIFF, EMF and WMF images +### Import a document with TIFF, EMF, and WMF images -The web browsers do not support to display metafile images like EMF and WMF and also TIFF format images. As a fallback approach, you can convert the metafile/TIFF format image to raster image using any image converter in the `MetafileImageParsed` event and this fallback raster image will be displayed in the client-side Document editor component. +Web browsers do not support displaying metafile images like EMF and WMF, or TIFF format images. As a fallback approach, you can convert the metafile/TIFF format image to a raster image using any image converter in the `MetafileImageParsed` event, and this fallback raster image will be displayed in the client-side Document Editor component. ->Note: In `MetafileImageParsedEventArgs` event argument, you can get the metafile stream using `MetafileStream` property and you can get the `IsMetafile` boolean value to determine whether the image is meta file images(WMF,EMF) or TIFF format images. In below example, we have converted the TIFF to raster image in `ConvertTiffToRasterImage()` method using `Bitmiracle https://www.nuget.org/packages/BitMiracle.LibTiff.NET`. +N> In the `MetafileImageParsedEventArgs` event argument, you can get the metafile stream using the `MetafileStream` property, and you can get the `IsMetafile` boolean value to determine whether the image is a metafile image (WMF, EMF) or a TIFF format image. In the example below, the TIFF is converted to a raster image in the `ConvertTiffToRasterImage()` method using [BitMiracle.LibTiff.NET](https://www.nuget.org/packages/BitMiracle.LibTiff.NET). -The following example code illustrates how to use `MetafileImageParsed` event for creating fallback raster image for metafile present in a Word document. +The following example code illustrates how to use the `MetafileImageParsed` event for creating a fallback raster image for a metafile present in a Word document. ```c# using SkiaSharp; @@ -205,9 +205,9 @@ The following example code illustrates how to write a Web API for paste with for ## Restrict editing -This Web API generates hash from the specified password and salt value which is required for restrict editing functionality of Document Editor component. +This Web API generates a hash from the specified password and salt value which is required for the restrict editing functionality of the Document Editor component. -The following example code illustrates how to write a Web API for restrict editing. +The following example code illustrates how to write a Web API to restrict editing. ```c# [AcceptVerbs("Post")] @@ -230,9 +230,9 @@ The following example code illustrates how to write a Web API for restrict editi } ``` -## Spell Check +## Spell check -Document Editor supports performing spell checking for any input text. You can perform spell checking for the text in Document Editor and it will provide suggestions for the mis-spelled words through dialog and in context menu. Document editor client-side script requires this Web API to show error words and list suggestions in context menu. This Web API returns the json type of spell-checked word which contains details about error words if any and suggestions. +Document Editor supports spell checking for input text. It identifies misspelled words and provides suggestions through a dialog and the context menu. The Document Editor client-side script requires this Web API to display error words and suggestions. This Web API returns a JSON response containing details about misspelled words and their suggestions. To know more about configure spell check, please check this [link](https://github.com/SyncfusionExamples/EJ2-Document-Editor-Web-Services/tree/master/ASP.NET%20Core#steps-to-configure-spell-checker). @@ -272,11 +272,11 @@ In startup.cs file, you can configure the spell check files like below: } ``` -Document editor provides options to spell check word by word and spellcheck page by page when loading the documents. +Document Editor provides options to spell check word by word and spellcheck page by page when loading the documents. ### Spell check word by word -This Web API performs the spell check word by word and return the json which contains information about error words and suggestions if any. By default, spell check word by word is performed in Document editor when enabling spell check in client-side. +This Web API performs the spell check word by word and returns the json which contains information about error words and suggestions if any. By default, spell check word by word is performed in the Document Editor when enabling spell check in client-side. The following example code illustrates how to write a Web API for spell check word by word. @@ -311,7 +311,7 @@ The following example code illustrates how to write a Web API for spell check wo ### Spell check page by page -This Web API performs the spell check page by page and return the json which contains information about error words and suggestions if any. By [enabling optimized spell check](../spell-check#enableoptimizedspellcheck) in client-side, you can perform spellcheck page by page when loading the documents. +This Web API performs the spell check page by page and returns the json which contains information about error words and suggestions if any. By [enabling optimized spell check](../spell-check#enableoptimizedspellcheck) in client-side, you can perform spellcheck page by page when loading the documents. The following example code illustrates how to write a Web API for spell check page by page. @@ -346,13 +346,13 @@ The following example code illustrates how to write a Web API for spell check pa ## Save as file formats other than SFDT and DOCX -You can configure this API, if you want to save the document in file format other than DOCX and SFDT using server-side. You can save the document in following ways: +You can configure this API if you want to save the document in a file format other than DOCX and SFDT on the server side. You can save the document in the following ways: -### Save the document in database or file server +### Save the document in a database or file server -This Web API saves the document in the server machine. You can customize this API to save the document into databases or file servers. +This Web API saves the document on the server. You can customize this API to save the document into databases or file servers. -The following example code illustrates how to write a Web API for save document in server-side. +The following example code illustrates how to write a Web API to save a document on the server side. ```c# [AcceptVerbs("Post")] @@ -368,7 +368,7 @@ The following example code illustrates how to write a Web API for save document name = "Document1.doc"; } WDocument document = WordDocument.Save(data.Content); - // Saves the document to server machine file system, you can customize here to save into databases or file servers based on requirement. + // Saves the document to the server file system. You can customize this to save into databases or file servers based on your requirements. FileStream fileStream = new FileStream(name, FileMode.OpenOrCreate, FileAccess.ReadWrite); document.Save(fileStream, GetWFormatType(format)); document.Close(); @@ -384,9 +384,9 @@ The following example code illustrates how to write a Web API for save document ### Save as other file formats by passing SFDT string -This Web API converts the SFDT string to required format and returns the document as FileStreamResult to client-side. Using this API, you can save the document in file format other than SFDT and DOCX and download the document in client browser. +This Web API converts the SFDT string to the required format and returns the document as a FileStreamResult to the client side. Using this API, you can save the document in a file format other than SFDT and DOCX and download the document in the client browser. -The following example code illustrates how to write a Web API for export sfdt. +The following example code illustrates how to write a Web API to export SFDT. ```c# [AcceptVerbs("Post")] @@ -456,9 +456,9 @@ The following example code illustrates how to write a Web API for export sfdt. ### Save as other file formats by passing DOCX file -This Web API converts the DOCX document to required format and returns the document as FileStreamResult to client-side. Using this API, you can save the document in file format other than SFDT and DOCX and download the document in client browser. +This Web API converts the DOCX document to the required format and returns the document as a FileStreamResult to the client side. Using this API, you can save the document in a file format other than SFDT and DOCX and download the document in the client browser. -The following example code illustrates how to write a Web API for export. +The following example code illustrates how to write a Web API to export. ```c# [AcceptVerbs("Post")] @@ -502,4 +502,4 @@ The following example code illustrates how to write a Web API for export. } ``` ->Note: Please refer the [ASP.NET Core Web API sample](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices/tree/master/ASP.NET%20Core). \ No newline at end of file +N> [View ASP.NET Core Web API sample in GitHub](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices/tree/master/ASP.NET%20Core). \ No newline at end of file diff --git a/Document-Processing/Word/Word-Processor/vue/web-services/java.md b/Document-Processing/Word/Word-Processor/vue/web-services/java.md index 84642f0aa4..3fb4e3e405 100644 --- a/Document-Processing/Word/Word-Processor/vue/web-services/java.md +++ b/Document-Processing/Word/Word-Processor/vue/web-services/java.md @@ -10,7 +10,7 @@ domainurl: ##DomainURL## # Java in Vue Document editor component -This page illustrates how to create web service in Java for the server-side dependent functionalities of Word Processor component a.k.a. Document Editor. Document Editor depends on server side interaction for below listed operations and it can be written in Java using `syncfusion-ej2-wordprocessor.jar` file. +This page illustrates how to create a web service in Java for the server-side dependencies of the Word Processor component (a.k.a. Document Editor). Document Editor depends on server-side interactions for the operations listed below, which can be written in Java using the `syncfusion-ej2-wordprocessor.jar` file. * Import Word Document * Paste with formatting @@ -20,9 +20,9 @@ This page illustrates how to create web service in Java for the server-side depe ## Supported Java versions -Syncfusion® Java library supports Java SE 8.0(1.8) or above versions. +Syncfusion® Java library supports Java SE 8.0 (1.8) or above. -## External Jars Required +## External jars required The following jar files are required to be referenced in your Java application. @@ -32,11 +32,11 @@ The following jar files are required to be referenced in your Java application. ## Download JAR file -The JAR file is available in both [Syncfusion® Essential-JS2](https://www.syncfusion.com/downloads/essential-js2) build and maven repository. +The JAR file is available in both the [Syncfusion® Essential-JS2](https://www.syncfusion.com/downloads/essential-js2) build and the Maven repository. ### Get JAR file from Syncfusion® build -You can get the `syncfusion-ej2-wordprocessor.jar` and its dependent jar files from Syncfusion® build installed location. +You can get the `syncfusion-ej2-wordprocessor.jar` and its dependent jar files from the Syncfusion® build installed location. **Syntax:** > Jar file: `(installed location)/Syncfusion/Essential Studio/{Platform}/{version}/JarFiles/syncfusion-ej2-wordprocessor-{version}.jar` @@ -44,7 +44,7 @@ You can get the `syncfusion-ej2-wordprocessor.jar` and its dependent jar files f **Example:** > Jar file: `C:/Program Files (x86)/Syncfusion/Essential Studio/Vue - EJ2/18.4.0.30/JarFiles/syncfusion-ej2-wordprocessor-18.4.0.30.jar` -You can also get the jar files by installing [file formats controls](https://www.syncfusion.com/sales/products/fileformats?utm_source=ug&utm_medium=listing&utm_campaign=java-word-processor#). You can find the required jars in the build installed location. +You can also get the jar files by installing [file format controls](https://www.syncfusion.com/sales/products/fileformats?utm_source=ug&utm_medium=listing&utm_campaign=java-word-processor#). You can find the required jars in the build installed location. **Syntax:** > Jar file: `(installed location)/Syncfusion/Essential Studio/{Platform}/{version}/JarFiles/syncfusion-ej2-wordprocessor-{version}.jar` @@ -52,15 +52,15 @@ You can also get the jar files by installing [file formats controls](https://www **Example:** > Jar file: `C:/Program Files (x86)/Syncfusion/Essential Studio/FileFormats/18.4.0.30/JarFiles/syncfusion-ej2-wordprocessor-18.4.0.30.jar` -### Referring JAR from Syncfusion® Maven Repository +### Refer to the JAR from the Syncfusion® Maven Repository -You can download the jars from the Syncfusion® [maven repository](https://jars.syncfusion.com/) to use our artifacts in your projects. It helps to use the Syncfusion® Java packages without installing Essential Studio® or platform installation to development with Syncfusion® controls. +You can download the jars from the Syncfusion® [Maven repository](https://jars.syncfusion.com/) to use our artifacts in your projects. It helps you use the Syncfusion® Java packages without installing Essential Studio® or platform installation for development with Syncfusion® controls. #### Download Syncfusion® Java packages -You can easily download the Syncfusion® packages for Java via maven repository. Follow the below guidelines to configure as per the tool. +You can easily download the Syncfusion® packages for Java via the Maven repository. Follow the guidelines below to configure as per the tool. -#### Refer the maven repository in build tool +#### Refer to the Maven repository in the build tool ##### Gradle @@ -83,7 +83,7 @@ You can easily download the Syncfusion® pac ``` -#### Refer the Syncfusion® package in your project as the dependency +#### Refer to the Syncfusion® package in your project as a dependency ##### Gradle @@ -105,13 +105,13 @@ You can easily download the Syncfusion® pac This section explains how to create the Java web service for DocumentEditor. -## Importing Word Document +## Importing Word Documents -As the Document editor client-side script requires the document in SFDT file format, you can convert the Word documents (.dotx,.docx,.docm), rich text format documents (.rtf), and text documents (.txt) into SFDT format by using this Web API. +As the Document Editor client-side script requires the document in SFDT file format, you can convert the Word documents (.dotx,.docx,.docm), rich text format documents (.rtf), and text documents (.txt) into SFDT format by using this Web API. -Note: Document editor Java library doesn’t have support for the **DOC format** Word document. As the DOC format is an older file format, we are concentrating on latest DOCX specific features and it will be more helpful in future if you use DOCX format to utilize some more features from Document editor. So, we recommend you to use the DOCX file format instead of DOC file format, to achieve your requirement. +N> The Document Editor Java library does not support the **DOC format** Word document. As the DOC format is an older file format, we recommend using the DOCX file format to take advantage of the latest features. -The following example code illustrates how to write a Web API for importing Word documents into Document Editor component. +The following example code illustrates how to write a Web API for importing Word documents into the Document Editor component. ```java @CrossOrigin(origins = "*", allowedHeaders = "*") @@ -126,13 +126,13 @@ The following example code illustrates how to write a Web API for importing Word } ``` -### Import document with TIFF, EMF and WMF images +### Import a document with TIFF, EMF, and WMF images -The web browsers do not support to display metafile images like EMF and WMF and also TIFF format images. As a fallback approach, you can convert the metafile/TIFF format image to raster image using any image converter in the `MetafileImageParsed` event and this fallback raster image will be displayed in the client-side Document editor component. +Web browsers do not support displaying metafile images like EMF and WMF, or TIFF format images. As a fallback approach, you can convert the metafile/TIFF format image to a raster image using any image converter in the `MetafileImageParsed` event, and this fallback raster image will be displayed in the client-side Document Editor component. ->Note: In `MetafileImageParsedEventArgs` event argument, you can get the metafile stream using `getMetafileStream()` property and you can get the `getIsMetafile()` boolean value to determine whether the image is meta file images(WMF,EMF) or TIFF format images. In below example, we have converted the TIFF to raster image in `ConvertTiffToRasterImage()` method using TwelveMonkeys ImageIO TIFF library. +N> In the `MetafileImageParsedEventArgs` event argument, you can get the metafile stream using the `getMetafileStream()` property, and you can get the `getIsMetafile()` boolean value to determine whether the image is a metafile image (WMF, EMF) or a TIFF format image. In the example below, the TIFF is converted to a raster image in the `ConvertTiffToRasterImage()` method using the TwelveMonkeys ImageIO TIFF library. -The following example code illustrates how to use `MetafileImageParsed` event for creating fallback raster image for metafile present in a Word document. +The following example code illustrates how to use the `MetafileImageParsed` event for creating a fallback raster image for a metafile present in a Word document. ```java import com.syncfusion.javahelper.system.collections.generic.*; @@ -283,9 +283,9 @@ The following example code illustrates how to write a Web API for paste with for ## Restrict editing -This Web API generates hash from the specified password and salt value which is required for restrict editing functionality of Document Editor component. +This Web API generates a hash from the specified password and salt value which is required for the restrict editing functionality of the Document Editor component. -The following example code illustrates how to write a Web API for restrict editing. +The following example code illustrates how to write a Web API to restrict editing. ```java @CrossOrigin(origins = "*", allowedHeaders = "*") @@ -328,13 +328,13 @@ The following example code illustrates how to write a Web API for restrict editi } ``` -## Spell Check +## Spell check -Document Editor supports performing spell checking for any input text. You can perform spell checking for the text in Document Editor and it will provide suggestions for the mis-spelled words through dialog and in context menu. Document editor client-side script requires this Web API to show error words and list suggestions in context menu. This Web API returns the json type of spell-checked word which contains details about error words if any and suggestions. +Document Editor supports performing spell checking for any input text. You can perform spell checking for the text in Document Editor and it will provide suggestions for the misspelled words through a dialog and the context menu. The Document Editor client-side script requires this Web API to display error words and list suggestions in the context menu. This Web API returns a JSON response containing details about the spell-checked words, including error words and suggestions if any. -To know more about configure spell check, please check this [link](https://github.com/SyncfusionExamples/EJ2-Document-Editor-Web-Services/tree/master/Java#steps-to-configure-spell-checker). +To know more about configuring spell check, refer to this [link](https://github.com/SyncfusionExamples/EJ2-Document-Editor-Web-Services/tree/master/Java#steps-to-configure-spell-checker). -In controller file, you can configure the spell check files like below: +In the controller file, you can configure the spell check files as below: ```java List spellDictionary; @@ -361,11 +361,11 @@ In controller file, you can configure the spell check files like below: } ``` -Document editor provides options to spell check word by word and spellcheck page by page when loading the documents. +Document Editor provides options to spell check word by word and spell check page by page when loading documents. ### Spell check word by word -This Web API performs the spell check word by word and return the json which contains information about error words and suggestions if any. By default, spell check word by word is performed in Document editor when enabling spell check in client-side. +This Web API performs the spell check word by word and returns the JSON which contains information about error words and suggestions if any. By default, spell check word by word is performed in the Document Editor when spell check is enabled on the client side. The following example code illustrates how to write a Web API for spell check word by word. @@ -402,7 +402,7 @@ The following example code illustrates how to write a Web API for spell check wo ### Spell check page by page -This Web API performs the spell check page by page and return the json which contains information about error words and suggestions if any. By [enabling optimized spell check](../spell-check#enableoptimizedspellcheck) in client-side, you can perform spellcheck page by page when loading the documents. +This Web API performs the spell check page by page and returns the JSON which contains information about error words and suggestions if any. By [enabling optimized spell check](../spell-check#enableoptimizedspellcheck) on the client side, you can perform spell check page by page when loading documents. The following example code illustrates how to write a Web API for spell check page by page. @@ -439,13 +439,13 @@ The following example code illustrates how to write a Web API for spell check pa ## Save as file formats other than SFDT and DOCX -You can configure this API, if you want to save the document in file format other than DOCX and SFDT using server-side. You can save the document in following ways: +You can configure this API if you want to save the document in a file format other than DOCX and SFDT on the server side. You can save the document in the following ways: -### Save the document in database or file server +### Save the document in a database or file server -This Web API saves the document in the server machine. You can customize this API to save the document into databases or file servers. +This Web API saves the document on the server. You can customize this API to save the document into databases or file servers. -The following example code illustrates how to write a Web API for save document in server-side. +The following example code illustrates how to write a Web API to save a document on the server side. ```c# @CrossOrigin(origins = "*", allowedHeaders = "*") @@ -458,7 +458,7 @@ The following example code illustrates how to write a Web API for save document name = "Document1.docx"; } WordDocument document = WordProcessorHelper.save(data.getContent()); - // Saves the document to server machine file system, you can customize here to save into databases or file servers based on requirement. + // Saves the document to the server file system. You can customize this to save into databases or file servers based on your requirements. FileOutputStream fileStream = new FileOutputStream(name); document.save(fileStream, getWFormatType(format)); fileStream.close(); @@ -518,9 +518,9 @@ The following example code illustrates how to write a Web API for save document ### Save as other file formats by passing SFDT string -This Web API converts the SFDT string to required format and returns the document as FileStreamResult to client-side. Using this API, you can save the document in file format other than SFDT and DOCX and download the document in client browser. +This Web API converts the SFDT string to the required format and returns the document as a FileStreamResult to the client side. Using this API, you can save the document in a file format other than SFDT and DOCX and download the document in the client browser. -The following example code illustrates how to write a Web API for export sfdt. +The following example code illustrates how to write a Web API to export SFDT. ```c# @CrossOrigin(origins = "*", allowedHeaders = "*") @@ -592,9 +592,9 @@ The following example code illustrates how to write a Web API for export sfdt. ### Save as other file formats by passing DOCX file -This Web API converts the DOCX document to required format and returns the document as FileStreamResult to client-side. Using this API, you can save the document in file format other than SFDT and DOCX and download the document in client browser. +This Web API converts the DOCX document to the required format and returns the document as a FileStreamResult to the client side. Using this API, you can save the document in a file format other than SFDT and DOCX and download the document in the client browser. -The following example code illustrates how to write a Web API for export. +The following example code illustrates how to write a Web API to export. ```c# @CrossOrigin(origins = "*", allowedHeaders = "*") @@ -641,4 +641,4 @@ The following example code illustrates how to write a Web API for export. } ``` ->Note: Please refer the [Java Web API example from GitHub](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices/tree/master/Java). \ No newline at end of file +N> Please refer to the [Java Web API example from GitHub](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices/tree/master/Java). \ No newline at end of file diff --git a/Document-Processing/Word/Word-Processor/vue/web-services/mvc.md b/Document-Processing/Word/Word-Processor/vue/web-services/mvc.md index 5359914878..8df4bfb2a2 100644 --- a/Document-Processing/Word/Word-Processor/vue/web-services/mvc.md +++ b/Document-Processing/Word/Word-Processor/vue/web-services/mvc.md @@ -10,7 +10,7 @@ domainurl: ##DomainURL## # MVC in Vue Document editor component -DocumentEditor depends on server side interaction for below listed operations can be written in ASP.NET MVC using [Syncfusion.EJ2.WordEditor.AspNet.Mvc5](https://www.nuget.org/packages/Syncfusion.EJ2.WordEditor.AspNet.Mvc5) or [Syncfusion.EJ2.WordEditor.AspNet.Mvc4](https://www.nuget.org/packages/Syncfusion.EJ2.WordEditor.AspNet.Mvc4). +DocumentEditor depends on server-side interactions for the operations listed below, which can be written in ASP.NET MVC using [Syncfusion.EJ2.WordEditor.AspNet.Mvc5](https://www.nuget.org/packages/Syncfusion.EJ2.WordEditor.AspNet.Mvc5) or [Syncfusion.EJ2.WordEditor.AspNet.Mvc4](https://www.nuget.org/packages/Syncfusion.EJ2.WordEditor.AspNet.Mvc4). * Import Word Document * Paste with formatting @@ -20,13 +20,13 @@ DocumentEditor depends on server side interaction for below listed operations ca This section explains how to create the service for DocumentEditor in ASP.NET MVC. -## Importing Word Document +## Importing Word documents -As the Document editor client-side script requires the document in SFDT file format, you can convert the Word documents (.dotx,.docx,.docm,.dot,.doc), rich text format documents (.rtf), and text documents (.txt) into SFDT format by using this Web API. +As the Document Editor client-side script requires the document in SFDT file format, you can convert the Word documents (.dotx,.docx,.docm,.dot,.doc), rich text format documents (.rtf), and text documents (.txt) into SFDT format by using this Web API. -The following example code illustrates how to write a Web API for importing Word documents into Document Editor component. +The following example code illustrates how to write a Web API for importing Word documents into the Document Editor component. -```c# +```csharp [HttpPost] [EnableCors("*", "*", "*")] [Route("Import")] @@ -55,7 +55,7 @@ This Web API converts the system clipboard data (HTML/RTF) to SFDT format which The following example code illustrates how to write a Web API for paste with formatting. -```c# +```csharp [HttpPost] [EnableCors("*", "*", "*")] [Route("SystemClipboard")] @@ -88,11 +88,11 @@ The following example code illustrates how to write a Web API for paste with for ## Restrict editing -This Web API generates hash from the specified password and salt value which is required for restrict editing functionality of Document Editor component. +This Web API generates a hash from the specified password and salt value which is required for the restrict editing functionality of the Document Editor component. -The following example code illustrates how to write a Web API for restrict editing. +The following example code illustrates how to write a Web API to restrict editing. -```c# +```csharp [HttpPost] [EnableCors("*", "*", "*")] [Route("RestrictEditing")] @@ -112,15 +112,15 @@ The following example code illustrates how to write a Web API for restrict editi } ``` -## Spell Check +## Spell check -Document Editor supports performing spell checking for any input text. You can perform spell checking for the text in Document Editor and it will provide suggestions for the mis-spelled words through dialog and in context menu. Document editor client-side script requires this Web API to show error words and list suggestions in context menu. This Web API returns the json type of spell-checked word which contains details about error words if any and suggestions. +Document Editor supports performing spell checking for any input text. You can perform spell checking for the text in Document Editor and it will provide suggestions for the misspelled words through a dialog and the context menu. The Document Editor client-side script requires this Web API to display error words and list suggestions in the context menu. This Web API returns a JSON response containing details about the spell-checked words, including error words and suggestions if any. -To know more about configure spell check, please check this [link](https://github.com/SyncfusionExamples/EJ2-Document-Editor-Web-Services/tree/master/ASP.NET%20MVC#steps-to-configure-spell-checker). +To know more about configuring spell check, refer to this [link](https://github.com/SyncfusionExamples/EJ2-Document-Editor-Web-Services/tree/master/ASP.NET%20MVC#steps-to-configure-spell-checker). -In `Global.asax.cs` file, you can configure the spell check files like below: +In the `Global.asax.cs` file, you can configure the spell check files as below: -```c# +```csharp internal static List spellDictCollection; internal static string path; internal static string personalDictPath; @@ -130,7 +130,7 @@ In `Global.asax.cs` file, you can configure the spell check files like below: //check the spell check dictionary path environment variable value and assign default data folder //if it is null. string path = HostingEnvironment.MapPath("//App_Data//"); - //Set the default spellcheck.json file if the json filename is empty. + //Set the default spellcheck.json file if the JSON filename is empty. string jsonFileName = HostingEnvironment.MapPath("//App_Data//spellcheck.json"); if (System.IO.File.Exists(jsonFileName)) { @@ -147,15 +147,15 @@ In `Global.asax.cs` file, you can configure the spell check files like below: } ``` -Document editor provides options to spell check word by word and spellcheck page by page when loading the documents. +Document Editor provides options to spell check word by word and spell check page by page when loading documents. ### Spell check word by word -This Web API performs the spell check word by word and return the json which contains information about error words and suggestions if any. By default, spell check word by word is performed in Document editor when enabling spell check in client-side. +This Web API performs the spell check word by word and returns the JSON which contains information about error words and suggestions if any. By default, spell check word by word is performed in the Document Editor when spell check is enabled on the client side. The following example code illustrates how to write a Web API for spell check word by word. -```c# +```csharp [HttpPost] [EnableCors("*", "*", "*")] [Route("SpellCheck")] @@ -186,11 +186,11 @@ The following example code illustrates how to write a Web API for spell check wo ### Spell check page by page -This Web API performs the spell check page by page and return the json which contains information about error words and suggestions if any. By [enabling optimized spell check](../spell-check#enableoptimizedspellcheck) in client-side, you can perform spellcheck page by page when loading the documents. +This Web API performs the spell check page by page and returns the JSON which contains information about error words and suggestions if any. By [enabling optimized spell check](../spell-check#enableoptimizedspellcheck) on the client side, you can perform spell check page by page when loading documents. The following example code illustrates how to write a Web API for spell check page by page. -```c# +```csharp [HttpPost] [EnableCors("*", "*", "*")] [Route("SpellCheckByPage")] @@ -221,15 +221,15 @@ The following example code illustrates how to write a Web API for spell check pa ## Save as file formats other than SFDT and DOCX -You can configure this API, if you want to save the document in file format other than DOCX and SFDT using server-side. You can save the document in following ways: +You can configure this API if you want to save the document in a file format other than DOCX and SFDT on the server side. You can save the document in the following ways: -### Save the document in database or file server +### Save the document in a database or file server -This Web API saves the document in the server machine. You can customize this API to save the document into databases or file servers. +This Web API saves the document on the server. You can customize this API to save the document into databases or file servers. -The following example code illustrates how to write a Web API for save document in server-side. +The following example code illustrates how to write a Web API to save a document on the server side. -```c# +```csharp [HttpPost] [EnableCors("AllowAllOrigins")] [Route("Save")] @@ -242,7 +242,7 @@ The following example code illustrates how to write a Web API for save document name = "Document1.doc"; } WDocument document = WordDocument.Save(data.Content); - // Saves the document to server machine file system, you can customize here to save into databases or file servers based on requirement. + // Saves the document to the server file system. You can customize this to save into databases or file servers based on your requirements. FileStream fileStream = new FileStream(name, FileMode.OpenOrCreate, FileAccess.ReadWrite); document.Save(fileStream, GetWFormatType(format)); document.Close(); @@ -258,11 +258,11 @@ The following example code illustrates how to write a Web API for save document ### Save as other file formats by passing SFDT string -This Web API converts the SFDT string to required format and returns the document as FileStreamResult to client-side. Using this API, you can save the document in file format other than SFDT and DOCX and download the document in client browser. +This Web API converts the SFDT string to the required format and returns the document as a FileStreamResult to the client side. Using this API, you can save the document in a file format other than SFDT and DOCX and download the document in the client browser. -The following example code illustrates how to write a Web API for export sfdt. +The following example code illustrates how to write a Web API to export SFDT. -```c# +```csharp [HttpPost] [EnableCors("AllowAllOrigins")] [Route("ExportSFDT")] @@ -329,11 +329,11 @@ The following example code illustrates how to write a Web API for export sfdt. ### Save as other file formats by passing DOCX file -This Web API converts the DOCX document to required format and returns the document as FileStreamResult to client-side. Using this API, you can save the document in file format other than SFDT and DOCX and download the document in client browser. +This Web API converts the DOCX document to the required format and returns the document as a FileStreamResult to the client side. Using this API, you can save the document in a file format other than SFDT and DOCX and download the document in the client browser. -The following example code illustrates how to write a Web API for export. +The following example code illustrates how to write a Web API to export. -```c# +```csharp [HttpPost] [EnableCors("AllowAllOrigins")] [Route("Export")] @@ -374,4 +374,4 @@ The following example code illustrates how to write a Web API for export. } ``` ->Note: Please refer the [ASP.NET MVC Web API sample](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices/tree/master/ASP.NET%20MVC). \ No newline at end of file +N> Please refer to the [ASP.NET MVC Web API sample](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices/tree/master/ASP.NET%20MVC). \ No newline at end of file