diff --git a/java-file-formats/word-library/Installation/Installation-errors.md b/java-file-formats/word-library/Installation/Installation-errors.md index 8b4ebce..fe4f914 100644 --- a/java-file-formats/word-library/Installation/Installation-errors.md +++ b/java-file-formats/word-library/Installation/Installation-errors.md @@ -1,10 +1,10 @@ --- layout: post title: Installation Errors in FileFormats - Syncfusion -description: Learn here about the common installation errors and solution to those errors in Syncfusion FileFormats Components installation. +description: Learn here about the common installation errors and solutions to those errors in Syncfusion FileFormats Components installation. platform: java-file-formats control: Installation and Deployment -documentation: ug +documentation: UG --- @@ -33,7 +33,7 @@ You are attempting to use a Trial unlock key to unlock the licensed installer. ### Suggested solution -Only a licensed unlock key can unlock a licensed installer. So, to unlock the Licensed installer, use the Licensed unlock key. To generate the licensed unlock key, refer to [this](http://syncfusion.com/kb/2326) article. +Only a licensed unlock key can unlock a licensed installer. So, to unlock the Licensed installer, use the Licensed unlock key. To generate the licensed unlock key, refer to [this](https://www.syncfusion.com/kb/2326) article. ## License has expired @@ -77,9 +77,9 @@ You can choose from the options listed below. The following are possible causes of this error: -* When your trial period expired -* When you don't have a license or an active trial -* You are not the license holder of your license +* Your trial period has expired. +* You do not have a license or an active trial. +* You are not the license holder for your organization's license. * Your account administrator has not yet assigned you a license. ### Suggested solution @@ -88,8 +88,8 @@ You can choose from the options listed below. 1. You can get a new license [here](https://www.syncfusion.com/sales/products). 2. Contact your account administrator. -3. Send an email to to request a license. -4. You can reach out to our sales team by emailing . +3. Send an email to to request a license. +4. You can reach out to our sales team by emailing . ## Unable to install because of another installation @@ -105,7 +105,7 @@ You are trying to install when another installation is already running in your m ### Suggested solution -Open and kill the msiexec process in the task manager and then continue to install Syncfusion®. If the problem is still present, restart the computer and try Syncfusion® installer. +Open the Task Manager and end the msiexec process, then continue to install Syncfusion®. If the problem is still present, restart the computer and try the Syncfusion® installer again. 1. Open the Windows Task Manager. @@ -141,7 +141,7 @@ You have enabled controlled folder access settings on your computer. 1. We will ship our demos in the public documents folder by default. 2. You have controlled folder access enabled on your machine, so our demos cannot be installed in the documents folder. If you need to install our demos in the Documents folder, follow the steps in this [link](https://support.microsoft.com/en-us/windows/allow-an-app-to-access-controlled-folders-b5b6627a-b008-2ca2-7931-7e51e912b034) and disable the controlled folder access. -3. You can enable this option after the installing our Syncfusion® setup. +3. You can enable this option after installing our Syncfusion® setup. **Suggestion 2:** diff --git a/java-file-formats/word-library/Installation/available-syncfusion-java-packages.md b/java-file-formats/word-library/Installation/available-syncfusion-java-packages.md index 6181bb8..5a4c599 100644 --- a/java-file-formats/word-library/Installation/available-syncfusion-java-packages.md +++ b/java-file-formats/word-library/Installation/available-syncfusion-java-packages.md @@ -8,7 +8,7 @@ documentation: UG # Available Syncfusion® Java packages -Below are the Java packages available in syncfusion®. +Below are the Java packages available in Syncfusion®. @@ -25,10 +25,10 @@ This jar contains the core features needed for creating, reading, and editing a +This jar contains common functionalities required for the Syncfusion® file format libraries.

+This jar is used for converting Word documents into Syncfusion® Document Text (*.SFDT) format documents.

syncfusion-javahelper

 -This jar contains common functionalities required for the syncfusion® file format libraries.

syncfusion-ej2-wordprocessor

 -This jar used for converting Word documents into Syncfusion® Document Text (*.SFDT) format documents.

\ No newline at end of file diff --git a/java-file-formats/word-library/Installation/configure-to-download-syncfusion-java-packages-from-apache-maven.md b/java-file-formats/word-library/Installation/configure-to-download-syncfusion-java-packages-from-apache-maven.md index 31ae573..993885b 100644 --- a/java-file-formats/word-library/Installation/configure-to-download-syncfusion-java-packages-from-apache-maven.md +++ b/java-file-formats/word-library/Installation/configure-to-download-syncfusion-java-packages-from-apache-maven.md @@ -9,7 +9,7 @@ documentation: UG You can easily download the Syncfusion® packages for Java using the [maven repository](https://jars.syncfusion.com/). -The following command shows how to mention the repository in Apache Maven. +The following snippet shows how to add the repository in the `pom.xml` of your Apache Maven project. {% tabs %} @@ -23,7 +23,7 @@ The following command shows how to mention the repository in Apache Maven. {% endtabs %} -The following command shows how to refer to the Syncfusion® package, which needs to be used in your project as the dependency. +The following snippet shows how to add the Syncfusion® package, which needs to be used in your project as the dependency in the `pom.xml` file. {% tabs %} @@ -36,3 +36,5 @@ The following command shows how to refer to the Syncfusion® Java package version](https://jars.syncfusion.com/) available for your license. diff --git a/java-file-formats/word-library/Installation/configure-to-download-syncfusion-java-packages-from-gradle.md b/java-file-formats/word-library/Installation/configure-to-download-syncfusion-java-packages-from-gradle.md index 0283816..55af127 100644 --- a/java-file-formats/word-library/Installation/configure-to-download-syncfusion-java-packages-from-gradle.md +++ b/java-file-formats/word-library/Installation/configure-to-download-syncfusion-java-packages-from-gradle.md @@ -5,11 +5,11 @@ platform: java-file-formats control: general documentation: UG --- -# Configure Gradle to download Syncfusion® Java packages +# Configure to download Syncfusion® Java packages from Gradle You can easily download the Syncfusion® packages for Java using the [maven repository](https://jars.syncfusion.com/). -The following command shows how to mention the repository in Gradle. +The following snippet shows how to add the repository in the `build.gradle` file of your Gradle project. {% tabs %} {% highlight groovy tabtitle="Gradle" %} @@ -22,7 +22,7 @@ repositories { {% endhighlight %} {% endtabs %} -The following command shows how to refer to the Syncfusion® package in Gradle, which needs to be used in your project as the dependency. +The following snippet shows how to add the Syncfusion® package in the `build.gradle` file, which needs to be used in your project as the dependency. {% tabs %} {% highlight groovy tabtitle="Gradle" %} @@ -31,3 +31,5 @@ dependencies { } {% endhighlight %} {% endtabs %} + +N> The version `18.4.0.30` shown above is for illustration only. Replace it with the [latest Syncfusion® Java package version](https://jars.syncfusion.com/) available for your license. diff --git a/java-file-formats/word-library/Installation/offline-installer/how-to-download.md b/java-file-formats/word-library/Installation/offline-installer/how-to-download.md index 34db7b2..029db81 100644 --- a/java-file-formats/word-library/Installation/offline-installer/how-to-download.md +++ b/java-file-formats/word-library/Installation/offline-installer/how-to-download.md @@ -4,7 +4,7 @@ title: Downloading Syncfusion FileFormats offline installer - Syncfusion description: Learn here about how to download the Syncfusion FileFormats offline installer from our Syncfusion website with license. platform: java-file-formats control: Installation and Deployment -documentation: ug +documentation: UG --- @@ -15,6 +15,8 @@ documentation: ug - Trial Installer - Licensed Installer +The following sections describe how to download each of these. + ## Download the Trial Version @@ -25,14 +27,14 @@ Our 30-day trial can be downloaded in two ways. ### Download Free Trial Setup -1. You can evaluate our 30-day free trial by visiting the [Download Free Trial](https://www.syncfusion.com/downloads) page and select the FileFormats platform. -2. After completing the required form or logging in with your registered Syncfusion® account, you can download the FileFormats trial installer from the confirmation page. (as shown in below screenshot.) +1. You can evaluate our 30-day free trial by visiting the [Download Free Trial](https://www.syncfusion.com/downloads) page and selecting the FileFormats platform. +2. After completing the required form or logging in with your registered Syncfusion® account, you can download the FileFormats trial installer from the confirmation page (as shown in the screenshot below). ![Trial and downloads of Syncfusion® Essential Studio®](images/trial-confirmation.png) 3. With a trial license, only the latest version’s trial installer can be downloaded. 4. After downloading, the Syncfusion® FileFormats trial installer can be unlocked using either the trial unlock key or the Syncfusion® registered login credential. More information on generating an unlock key can be found in [this](https://www.syncfusion.com/kb/8069/how-to-generate-unlock-key-for-essentials-studio-products) article. -5. Before the trial expires, you can download the trial installer at any time from your registered account’s [Trials & Downloads](https://www.syncfusion.com/account/manage-trials/downloads) page (as shown in below screenshot.) +5. Before the trial expires, you can download the trial installer at any time from your registered account's [Trials & Downloads](https://www.syncfusion.com/account/manage-trials/downloads) page (as shown in the screenshot below). ![Trial and downloads of Syncfusion® Essential Studio®](images/trial-download.png) @@ -46,12 +48,12 @@ Our 30-day trial can be downloaded in two ways. ![Trial and downloads of Syncfusion® Essential Studio®](images/start-trial-download.png) -2. To access this page, you must sign up\log in with your Syncfusion® account. +2. To access this page, you must sign up/log in with your Syncfusion® account. 3. Begin your trial by selecting the FileFormats product. N> If you've already used the trial products and they haven't expired, you won't be able to start the trial for the same product again. -4. After you've started the trial, go to the [Trials & Downloads](https://www.syncfusion.com/account/manage-trials/downloads) page to get the latest version trial installer. You can generate the [unlock key](https://www.syncfusion.com/kb/8069/how-to-generate-unlock-key-for-essentials-studio-products) and [license key](https://help.syncfusion.com/document-processing/licensing/how-to-generate) here at any time before the trial period expires. (as shown in below screenshot.) +4. After you've started the trial, go to the [Trials & Downloads](https://www.syncfusion.com/account/manage-trials/downloads) page to get the latest version trial installer. You can generate the [unlock key](https://www.syncfusion.com/kb/8069/how-to-generate-unlock-key-for-essentials-studio-products) and [license key](https://help.syncfusion.com/document-processing/licensing/how-to-generate) here at any time before the trial period expires (as shown in the screenshot below). ![License and downloads of Syncfusion® Essential Studio®](images/start-trial-download-installer.png) @@ -65,7 +67,7 @@ Our 30-day trial can be downloaded in two ways. 3. Click the Download (element 1 in the screenshot below) button to download the respective product’s installer. 4. The most recent version of the installer will be downloaded from this page. 5. To download older version installers, go to [Downloads Older Versions](https://www.syncfusion.com/account/downloads/studio) (element 2 in the screenshot below). -6. You can download other platform\add-on installers by going to More Downloads Options (element 3 in the screenshot below). +6. You can download other platform/add-on installers by going to More Downloads Options (element 3 in the screenshot below). ![License and downloads of Syncfusion® Essential Studio®](images/license-download.png) diff --git a/java-file-formats/word-library/Installation/offline-installer/how-to-install.md b/java-file-formats/word-library/Installation/offline-installer/how-to-install.md index dedc0d1..78ee26d 100644 --- a/java-file-formats/word-library/Installation/offline-installer/how-to-install.md +++ b/java-file-formats/word-library/Installation/offline-installer/how-to-install.md @@ -1,10 +1,10 @@ --- layout: post -title: Installing Syncfusion FileFormats offline installer-Syncfusion +title: Installing Syncfusion FileFormats offline installer - Syncfusion description: Learn here about how to install Syncfusion FileFormats offline installer after downloading from our Syncfusion website. platform: java-file-formats control: Installation and Deployment -documentation: ug +documentation: UG --- @@ -14,7 +14,7 @@ documentation: ug The steps below show how to install the Essential Studio® FileFormats installer. -1. Open the Syncfusion® FileFormats offline installer file from downloaded location by double-clicking it. The Installer Wizard automatically opens and extracts the package. +1. Open the Syncfusion® FileFormats offline installer file from the downloaded location by double-clicking it. The Installer Wizard automatically opens and extracts the package. ![Installer extraction wizard](images/Step-by-Step-Installation_img1.png) @@ -50,24 +50,24 @@ The steps below show how to install the Essential Studio® samples, or leave the check box unchecked, if you do not want to install Syncfusion® samples + * Select the **Install Demos** check box to install Syncfusion® samples, or leave the check box unchecked if you do not want to install Syncfusion® samples. * Select the **Register Syncfusion® Assemblies in GAC** check box to install the latest Syncfusion® assemblies in GAC, or clear this check box when you do not want to install the latest assemblies in GAC. - * Select the **Configure Syncfusion® controls in Visual Studio** check box to configure the Syncfusion® controls in the Visual Studio toolbox, or clear this check box when you do not want to configure the Syncfusion® controls in the Visual Studio toolbox during installation. Note that you must also select the Register Syncfusion® assemblies in GAC check box when you select this check box. - * Select the **Configure Syncfusion® Extensions controls in Visual Studio** checkbox to configure the Syncfusion® Extensions in Visual Studio or clear this check box when you do not want to configure the Syncfusion® Extensions in Visual Studio. - * Check the **Create Desktop Shortcut** checkbox to add a desktop shortcut for Syncfusion® Control Panel - * Check the **Create Start Menu Shortcut** checkbox to add a shortcut to the start menu for Syncfusion® Control Panel + * Select the **Configure Syncfusion® controls in Visual Studio** check box to configure the Syncfusion® controls in the Visual Studio toolbox, or clear this check box when you do not want to configure the Syncfusion® controls in the Visual Studio toolbox during installation. Note that you must also select the **Register Syncfusion® Assemblies in GAC** check box when you select this check box. + * Select the **Configure Syncfusion® Extensions controls in Visual Studio** check box to configure the Syncfusion® Extensions in Visual Studio, or clear this check box when you do not want to configure the Syncfusion® Extensions in Visual Studio. + * Check the **Create Desktop Shortcut** check box to add a desktop shortcut for the Syncfusion® Control Panel. + * Check the **Create Start Menu Shortcut** check box to add a shortcut to the start menu for the Syncfusion® Control Panel. -5. If any previous versions of the current product is installed, the Uninstall Previous Version(s) wizard will be opened. Select **Uninstall** checkbox to uninstall the previous versions and then click the Proceed button. +5. If any previous versions of the current product are installed, the Uninstall Previous Version(s) wizard will be opened. Select the **Uninstall** checkbox to uninstall the previous versions and then click the Proceed button. ![Advanced options](images/Step-by-Step-Installation_img7.png) @@ -76,7 +76,7 @@ The steps below show how to install the Essential Studio® has added the option to uninstall previous versions from 18.1 while installing the new version. - N> If any version is selected to uninstall, a confirmation screen will appear; if continue is selected, the Progress screen will display the uninstall and install progress, respectively. If none of the versions are chosen to be uninstalled, only the installation progress will be displayed. + N> If any version is selected to uninstall, a confirmation screen will appear; if Continue is selected, the Progress screen will display the uninstall and install progress, respectively. If none of the versions are chosen to be uninstalled, only the installation progress will be displayed. **Confirmation Alert** @@ -90,17 +90,17 @@ The steps below show how to install the Essential Studio® Control Panel. +6. After installing, click the **Launch Control Panel** link to open the Syncfusion® Control Panel. -8. Click the Finish button. Your system has been installed with the Syncfusion® Essential Studio® FileFormats product. +7. Click the Finish button. Your system has been installed with the Syncfusion® Essential Studio® FileFormats product. - N> * You can find the required jars in the FileFormats installed location - * **Location:** {ProgramFilesFolder}\Syncfusion\Essential Studio\ {Platform}\ {version}\JarFiles + N> * You can find the required jars in the FileFormats installed location (Windows). + * **Location:** {ProgramFilesFolder}\Syncfusion\Essential Studio\{Platform}\{version}\JarFiles * **Example:** C:\Program Files (x86)\Syncfusion\Essential Studio\FileFormats\19.1.0.54\JarFiles ## Installing in silent mode @@ -113,13 +113,13 @@ To install through the Command Line in Silent mode, follow the steps below. 1. Run the Syncfusion® FileFormats installer by double-clicking it. The Installer Wizard automatically opens and extracts the package. 2. The file syncfusionessentialfileformats_(version).exe file will be extracted into the Temp directory. -3. Run %temp%. The Temp folder will be opened. The syncfusionessentialfileformats_(version).exe file will be located in one of the folders. -4. Copy the extracted syncfusionessentialfileformats_(version).exe file in local drive. +3. Open the Run dialog, enter `%temp%`, and press Enter. The Temp folder will be opened. The syncfusionessentialfileformats_(version).exe file will be located in one of the folders. +4. Copy the extracted syncfusionessentialfileformats_(version).exe file to a local drive. 5. Exit the Wizard. 6. Run Command Prompt in administrator mode and enter the following arguments. - **Arguments:** “installer file path\SyncfusionEssentialStudio(platform)_(version).exe” /Install silent /UNLOCKKEY:“(product unlock key)” [/log “{Log file path}”] [/InstallPath:{Location to install}] [/InstallSamples:{true/false}] [/InstallAssemblies:{true/false}] [/UninstallExistAssemblies:{true/false}] [/InstallToolbox:{true/false}] + **Arguments:** “installer file path\syncfusionessentialfileformats_(version).exe” /Install silent /UNLOCKKEY:“(product unlock key)” [/log “{Log file path}”] [/InstallPath:{Location to install}] [/InstallSamples:{true/false}] [/InstallAssemblies:{true/false}] [/UninstallExistAssemblies:{true/false}] [/InstallToolbox:{true/false}] N> [..] – Arguments inside the square brackets are optional. @@ -134,20 +134,18 @@ To install through the Command Line in Silent mode, follow the steps below. ### Command Line Uninstallation -Syncfusion® Essential® FileFormats can be uninstalled silently using the Command Line. +Syncfusion® Essential Studio® FileFormats can be uninstalled silently using the Command Line. 1. Run the Syncfusion® FileFormats installer by double-clicking it. The Installer Wizard automatically opens and extracts the package. 2. The file syncfusionessentialfileformats_(version).exe file will be extracted into the Temp directory. -3. Run %temp%. The Temp folder will be opened. The syncfusionessentialfileformats_(version).exe file will be located in one of the folders. -4. Copy the extracted syncfusionessentialfileformats_(version).exe file in local drive. +3. Open the Run dialog, enter `%temp%`, and press Enter. The Temp folder will be opened. The syncfusionessentialfileformats_(version).exe file will be located in one of the folders. +4. Copy the extracted syncfusionessentialfileformats_(version).exe file to a local drive. 5. Exit the Wizard. 6. Run Command Prompt in administrator mode and enter the following arguments. - **Arguments:** “Copied installer file path\syncfusionessentialfileformats_(version).exe” /uninstall silent  + **Arguments:** “Copied installer file path\syncfusionessentialfileformats_(version).exe” /uninstall silent **Example:** “D:\Temp\syncfusionessentialfileformats_x.x.x.x.exe" /uninstall silent -7. Essential Studio® for WPF is uninstalled. - - +7. Essential Studio® for FileFormats is uninstalled. diff --git a/java-file-formats/word-library/Installation/web-installer/how-to-download.md b/java-file-formats/word-library/Installation/web-installer/how-to-download.md index d951fe8..377da11 100644 --- a/java-file-formats/word-library/Installation/web-installer/how-to-download.md +++ b/java-file-formats/word-library/Installation/web-installer/how-to-download.md @@ -4,7 +4,7 @@ title: Downloading Syncfusion FileFormats web installer - Syncfusion description: Learn here about how to download Syncfusion FileFormats web installer from our Syncfusion website with license. platform: java-file-formats control: Installation and Deployment -documentation: ug +documentation: UG --- @@ -15,6 +15,8 @@ documentation: ug - Trial Installer - Licensed Installer +The following sections describe how to download each of these. + ## Download the Trial Version @@ -25,14 +27,14 @@ Our 30-day trial can be downloaded in two ways. ### Download Free Trial Setup -1. You can evaluate our 30-day free trial by visiting the [Download Free Trial](https://www.syncfusion.com/downloads) page and select the FileFormats platform. -2. After completing the required form or logging in with your registered Syncfusion® account, you can download the FileFormats trial installer from the confirmation page. (as shown in below screenshot.) +1. You can evaluate our 30-day free trial by visiting the [Download Free Trial](https://www.syncfusion.com/downloads) page and selecting the FileFormats platform. +2. After completing the required form or logging in with your registered Syncfusion® account, you can download the FileFormats trial installer from the confirmation page (as shown in the screenshot below). ![Trial and downloads of Syncfusion® Essential Studio®](images/trial-confirmation.png) 3. With a trial license, only the latest version’s trial installer can be downloaded. 4. After downloading, the Syncfusion® FileFormats trial installer can be unlocked using either the trial unlock key or the Syncfusion® registered login credential. More information on generating an unlock key can be found in [this](https://www.syncfusion.com/kb/8069/how-to-generate-unlock-key-for-essentials-studio-products) article. -5. Before the trial expires, you can download the trial installer at any time from your registered account’s [Trials & Downloads](https://www.syncfusion.com/account/manage-trials/downloads) page (as shown in below screenshot.) +5. Before the trial expires, you can download the trial installer at any time from your registered account’s [Trials & Downloads](https://www.syncfusion.com/account/manage-trials/downloads) page (as shown in the below screenshot). 6. Click the Download (element 1 in the screenshot below) button to get the Syncfusion® Essential Studio® FileFormats web installer. ![Trial and downloads of Syncfusion® Essential Studio®](images/trial-download.png) @@ -44,12 +46,12 @@ Our 30-day trial can be downloaded in two ways. ![Trial and downloads of Syncfusion® Essential Studio®](images/start-trial-download.png) -2. To access this page, you must sign up\log in with your Syncfusion® account. +2. To access this page, you must sign up/log in with your Syncfusion® account. 3. Begin your trial by selecting the FileFormats product. N> If you've already used the trial products and they haven't expired, you won't be able to start the trial for the same product again. -4. After you've started the trial, go to the [Trials & Downloads](https://www.syncfusion.com/account/manage-trials/downloads) page to get the latest version trial installer. You can generate the [unlock key](https://www.syncfusion.com/kb/8069/how-to-generate-unlock-key-for-essentials-studio-products) and [license key](https://help.syncfusion.com/document-processing/licensing/how-to-generate) here at any time before the trial period expires. (as shown in below screenshot.) +4. After you've started the trial, go to the [Trials & Downloads](https://www.syncfusion.com/account/manage-trials/downloads) page to get the latest version trial installer. You can generate the [unlock key](https://www.syncfusion.com/kb/8069/how-to-generate-unlock-key-for-essentials-studio-products) and [license key](https://help.syncfusion.com/document-processing/licensing/how-to-generate) here at any time before the trial period expires (as shown in the screenshot below). ![License and downloads of Syncfusion® Essential Studio®](images/start-trial-download-installer.png) @@ -63,11 +65,11 @@ Our 30-day trial can be downloaded in two ways. 3. Click the Download (element 1 in the screenshot below) button to download the respective product’s installer. 4. The most recent version of the installer will be downloaded from this page. 5. To download older version installers, go to [Downloads Older Versions](https://www.syncfusion.com/account/downloads/studio) (element 2 in the screenshot below). -6. You can download other platform\add-on installers by going to More Downloads Options (element 3 in the screenshot below). +6. You can download other platform/add-on installers by going to More Downloads Options (element 3 in the screenshot below). ![License and downloads of Syncfusion® Essential Studio®](images/license-download.png) -7. Before the license expires, you can download the installer at any time from your registered account’s [License & Downloads](https://www.syncfusion.com/account/downloads) page (See the screenshot below.) +7. Before the license expires, you can download the installer at any time from your registered account's [License & Downloads](https://www.syncfusion.com/account/downloads) page (as shown in the screenshot below). ![License and downloads of Syncfusion® Essential Studio®](images/start-trial-download-web-installer.png) diff --git a/java-file-formats/word-library/Installation/web-installer/how-to-install.md b/java-file-formats/word-library/Installation/web-installer/how-to-install.md index 1e0158a..bf2293a 100644 --- a/java-file-formats/word-library/Installation/web-installer/how-to-install.md +++ b/java-file-formats/word-library/Installation/web-installer/how-to-install.md @@ -4,7 +4,7 @@ title: Installing Syncfusion FileFormats web installer - Syncfusion description: Learn here about how to install Syncfusion FileFormats web installer after downloading from our Syncfusion website. platform: java-file-formats control: Installation and Deployment -documentation: ug +documentation: UG --- # Installing Syncfusion® FileFormats web installer @@ -19,7 +19,7 @@ For the Essential Studio® FileFormats produ The steps below show how to install Essential Studio® FileFormats Web Installer. -1. Open the Syncfusion® Essential Studio® FileFormats Web Installer file from downloaded location by double-clicking it. The Installer Wizard automatically opens and extracts the package. +1. Open the Syncfusion® Essential Studio® FileFormats Web Installer file from the downloaded location by double-clicking it. The Installer Wizard automatically opens and extracts the package. ![Installer Extraction Wizard](images/Step-by-Step-Installation_img1.png) @@ -54,10 +54,10 @@ The steps below show how to install Essential Studio& ![Existing Version for install](images/Step-by-Step-Installation_img20.png) - N> From the 2021 Volume 1 release, Syncfusion® has provided option to uninstall the previous versions from 18.1 while installing the new version. + N> From the 2021 Volume 1 release, Syncfusion® has provided the option to uninstall the previous versions from 18.1 while installing the new version. -5. Pop up screen will be displayed to get the confirmation to uninstall selected previous versions. +5. A pop-up screen will be displayed to get confirmation to uninstall the selected previous versions. ![Existing Version for install](images/Step-by-Step-Installation_img21.png) @@ -66,7 +66,7 @@ The steps below show how to install Essential Studio& ![Confirmation for install/uninstall](images/Step-by-Step-Installation_img15.png) - N> By clicking the **Download Size and Installation** Size links, you can determine the approximate size of the download and installation + N> By clicking the **Download Size** and **Installation Size** links, you can determine the approximate size of the download and installation. 7. The Configuration Wizard will appear. You can change the Download, Install, and Demos locations from here. You can also change the Additional settings on a product-by-product basis. Click Next to install with the default settings. @@ -75,12 +75,12 @@ The steps below show how to install Essential Studio& **Additional settings** - * Select the **Install Demos** check box to install Syncfusion® samples, or leave the check box unchecked, if you do not want to install Syncfusion® samples + * Select the **Install Demos** check box to install Syncfusion® samples, or leave the check box unchecked if you do not want to install Syncfusion® samples. * Select the **Register Syncfusion® Assemblies in GAC** check box to install the latest Syncfusion® assemblies in GAC, or clear this check box when you do not want to install the latest assemblies in GAC. - * Select the **Configure Syncfusion® controls in Visual Studio** check box to configure the Syncfusion® controls in the Visual Studio toolbox, or clear this check box when you do not want to configure the Syncfusion® controls in the Visual Studio toolbox during installation. Note that you must also select the Register Syncfusion® assemblies in GAC check box when you select this check box. - * Select the **Configure Syncfusion® Extensions controls in Visual Studio** checkbox to configure the Syncfusion® Extensions in Visual Studio or clear this check box when you do not want to configure the Syncfusion® Extensions in Visual Studio. - * Check the **Create Desktop Shortcut** checkbox to add a desktop shortcut for Syncfusion® Control Panel - * Check the **Create Start Menu Shortcut** checkbox to add a shortcut to the start menu for Syncfusion® Control Panel + * Select the **Configure Syncfusion® controls in Visual Studio** check box to configure the Syncfusion® controls in the Visual Studio toolbox, or clear this check box when you do not want to configure the Syncfusion® controls in the Visual Studio toolbox during installation. Note that you must also select the **Register Syncfusion® Assemblies in GAC** check box when you select this check box. + * Select the **Configure Syncfusion® Extensions controls in Visual Studio** check box to configure the Syncfusion® Extensions in Visual Studio, or clear this check box when you do not want to configure the Syncfusion® Extensions in Visual Studio. + * Check the **Create Desktop Shortcut** check box to add a desktop shortcut for the Syncfusion® Control Panel. + * Check the **Create Start Menu Shortcut** check box to add a shortcut to the start menu for the Syncfusion® Control Panel. @@ -92,7 +92,7 @@ The steps below show how to install Essential Studio& I> The products you have chosen will be installed based on your Syncfusion® License (Trial or Licensed). -10. The download and installation\uninstallation progress will be displayed as shown below. +10. The download, installation, and uninstallation progress will be displayed as shown below. ![Download and Installation progress install](images/Step-by-Step-Installation_img10.png) @@ -106,8 +106,8 @@ The steps below show how to install Essential Studio& ![Control Panel](images/Step-by-Step-Installation_img19.png) - N> * You can find the required jars in the FileFormats installed location - * **Location:** {ProgramFilesFolder}\Syncfusion\Essential Studio\ {Platform}\ {version}\JarFiles + N> * You can find the required jars in the FileFormats installed location (Windows). + * **Location:** {ProgramFilesFolder}\Syncfusion\Essential Studio\{Platform}\{version}\JarFiles * **Example:** C:\Program Files (x86)\Syncfusion\Essential Studio\FileFormats\19.1.0.54\JarFiles ## Uninstallation @@ -117,7 +117,7 @@ Syncfusion® FileFormats installer can be un * Uninstall the FileFormats using the Syncfusion® FileFormats web installer * Uninstall the FileFormats from Windows Control Panel -Follow either one of the option below to uninstall Syncfusion® Essential Studio® FileFormats installer. +Follow either one of the options below to uninstall the Syncfusion® Essential Studio® FileFormats installer. **Option 1: Uninstall the FileFormats using the Syncfusion® FileFormats web installer** @@ -144,17 +144,17 @@ N> If the **Syncfusion® Essential Studio**Available** ![Platform Selection wizard Available](images/Step-by-Step-Installation_img25.png) -3. If any other products selected for installation, Uninstall previous version wizard will be displayed with previous version(s) installed for the selected products. Here you can view the list of installed previous versions for the selected products. Select **Uninstall All** checkbox to select all the versions. Click Next. +3. If any other products are selected for installation, the Uninstall previous version wizard will be displayed with the previous version(s) installed for the selected products. Here you can view the list of installed previous versions for the selected products. Select the **Uninstall All** checkbox to select all the versions. Click Next. ![Existing Version for install](images/Step-by-Step-Installation_img26.png) -4. Pop up screen will be displayed to get the confirmation to uninstall selected previous versions. +4. A pop-up screen will be displayed to get confirmation to uninstall the selected previous versions. ![Existing Version for install](images/Step-by-Step-Installation_img21.png) @@ -162,7 +162,7 @@ N> If the **Syncfusion® Essential Studio By clicking the **Download Size and Installation** Size links, you can determine the approximate size of the download and installation + N> By clicking the **Download Size** and **Installation Size** links, you can determine the approximate size of the download and installation. 6. The Configuration Wizard will appear. You can change the Download, Install, and Demos locations from here. You can also change the Additional settings on a product-by-product basis. Click Next to install with the default settings. @@ -176,11 +176,11 @@ N> If the **Syncfusion® Essential Studio The products you have chosen will be installed based on your Syncfusion® License (Trial or Licensed). -9. The download, installation, and uninstallation progresses will be shown. +9. The download, installation, and uninstallation progress will be shown. ![Download and Installation progress install/uninstall](images/Step-by-Step-Installation_img17.png) -10. When the installation is finished, the **Summary** wizard will appear. Here you can see the list of products that have been successfully and unsuccessfully installed/uninstalled. To close the Summary wizard, click Finish. +10. When the installation is finished, the **Summary** wizard will appear. Here you can see the list of products that have been successfully installed/uninstalled and those that failed. To close the Summary wizard, click Finish. ![Summary install/uninstall](images/Step-by-Step-Installation_img18.png) diff --git a/java-file-formats/word-library/accepting-or-rejecting-track-changes.md b/java-file-formats/word-library/accepting-or-rejecting-track-changes.md index 0854f8b..3d35728 100644 --- a/java-file-formats/word-library/accepting-or-rejecting-track-changes.md +++ b/java-file-formats/word-library/accepting-or-rejecting-track-changes.md @@ -7,10 +7,9 @@ documentation: UG --- # Accepting or Rejecting Track Changes -It is used to keep track of the changes made to a Word document. It helps to maintain the record of author, name and time for every insertion, deletion, or modification in a document. This can be enabled by using the TrackChanges property of the Word document. +Track changes is used to keep track of the changes made to a Word document. It helps to maintain the record of author, date, and time for every insertion, deletion, or modification in a document. This can be enabled by using the TrackChanges property of the Word document. -N> -With this support, the changes made in the Word document by DocIO library cannot be tracked. +N> With this support, the changes made in the Word document by DocIO library cannot be tracked. The following code example illustrates how to enable track changes of the document. @@ -170,7 +169,7 @@ document.close(); {% endtabs %} -Frequently Asked Questions +## Frequently Asked Questions * [How to check whether a Word document contains tracked changes or not?](https://help.syncfusion.com/document-processing/word/word-library/java/faq#how-to-check-whether-a-word-document-contains-tracked-changes-or-not) * [How to accept or reject track changes of specific type in the Word document?](https://help.syncfusion.com/document-processing/word/word-library/java/faq#how-to-accept-or-reject-track-changes-of-specific-type-in-the-word-document) diff --git a/java-file-formats/word-library/applying-watermark.md b/java-file-formats/word-library/applying-watermark.md index 5e0eebe..a8694e7 100644 --- a/java-file-formats/word-library/applying-watermark.md +++ b/java-file-formats/word-library/applying-watermark.md @@ -18,6 +18,8 @@ You can add or modify text watermark in the Word document. The `TextWatermark` c The following code example shows how to add a text watermark to the Word document. +N> The `TextWatermark` constructor accepts the following parameters: text, alternate text, width, and height. + {% tabs %} {% highlight JAVA %} @@ -46,12 +48,14 @@ document.close(); {% endtabs %} -## Picture Watermark +## Picture watermark You can add or modify the picture watermark in the Word document. The `PictureWatermark` class represents the picture watermark in the Word document. The following code example shows how to add a picture watermark to the Word document. +N> The above code example uses `java.nio.file.Path` and `java.nio.file.Files` classes to read the image bytes. Ensure the image file path points to a valid image on the system. + {% tabs %} {% highlight JAVA %} diff --git a/java-file-formats/word-library/conversion.md b/java-file-formats/word-library/conversion.md index 2d381ba..ec02b67 100644 --- a/java-file-formats/word-library/conversion.md +++ b/java-file-formats/word-library/conversion.md @@ -27,13 +27,13 @@ Essential® DocIO can convert various flow d ## HTML conversion -Essential® DocIO supports converting the HTML file into Word document and vice versa. It supports only the HTML files that meet the validation either against XHTML 1.0 strict or XHTML 1.0 Transitional schema. +Essential® DocIO supports converting the HTML file into Word document and vice versa. It supports only the HTML files that meet the validation either against XHTML 1.0 strict or XHTML 1.0 Transitional schema. -For further information kindly refer this [link](https://help.syncfusion.com/document-processing/word/word-library/java/html#). +For further information, kindly refer this [link](https://help.syncfusion.com/document-processing/word/word-library/java/html). ### Supported Document elements -Kindly refer to this [link](https://help.syncfusion.com/document-processing/word/word-library/java/html#supported-and-unsupported-items#) for the document elements and attributes that are supported by DocIO in the Word to HTML and HTML to Word conversions. +Kindly refer to this [link](https://help.syncfusion.com/document-processing/word/word-library/java/html#supported-and-unsupported-items) for the document elements and attributes that are supported by DocIO in the Word to HTML and HTML to Word conversions. ## Text file diff --git a/java-file-formats/word-library/convert-markdown-to-word-document-in-java.md b/java-file-formats/word-library/convert-markdown-to-word-document-in-java.md index e4ea345..e6aec5b 100644 --- a/java-file-formats/word-library/convert-markdown-to-word-document-in-java.md +++ b/java-file-formats/word-library/convert-markdown-to-word-document-in-java.md @@ -31,7 +31,7 @@ T> You can also save the markdown file as [HTML](https://help.syncfusion.com/doc ## Customize image data -The Java Word library provides a ImageNodeVisited event, which customizes image data while importing a Markdown file. Implement the logic to customize the image data by using this ImageNodeVisited event. +The Java Word library provides an ImageNodeVisited event, which customizes image data while importing a Markdown file. Implement the logic to customize the image data by using this ImageNodeVisited event. The following code example shows how to load image data based on the image source path when importing the Markdown files. @@ -66,9 +66,10 @@ public void remove(MdImageNodeVisitedEventHandler delegate) throws Exception } }); //Open the Markdown file. -document.Open("Input.md"); +document.open("Input.md", FormatType.Markdown); //Save as a Word document. -document.Save("Sample.docx"); +document.save("Sample.docx", FormatType.Docx); +document.close(); {% endhighlight %} {% endtabs %} @@ -348,7 +349,7 @@ N> Hook the event handler before opening a Word document as per the above code e

For image, enclose an alternative text within the brackets [], and then link of the image source within parentheses ().

-

If URL path is base64string, then it will be preserved properly in Word document. Otherwise, you can also {{'[set image from stream while opening Markdown file.](https://help.syncfusion.com/document-processing/word/word-library/java/convert-markdown-to-word-document-in-java#customize-image-data)'| markdownify }}

+

If URL path is base64string, then it will be preserved properly in Word document. Otherwise, you can also {{'[set image from stream while opening Markdown file.](https://help.syncfusion.com/document-processing/word/word-library/java/convert-markdown-to-word-document-in-java#customize-image-data)'| markdownify }}

diff --git a/java-file-formats/word-library/document-object-model-representation.md b/java-file-formats/word-library/document-object-model-representation.md index de24cea..4c2b4e1 100644 --- a/java-file-formats/word-library/document-object-model-representation.md +++ b/java-file-formats/word-library/document-object-model-representation.md @@ -1,6 +1,6 @@ --- title: Document Object Model representation -description: This section describes about DOM structure +description: This section describes the DOM structure platform: java-file-formats control: Word Library documentation: UG diff --git a/java-file-formats/word-library/faq.md b/java-file-formats/word-library/faq.md index 333630e..529f241 100644 --- a/java-file-formats/word-library/faq.md +++ b/java-file-formats/word-library/faq.md @@ -368,9 +368,9 @@ document.close(); {% endtabs %} -## Which units does Java Word library uses for measurement properties such as size, margins, etc, in a Word document? +## Which units does the Java Word library use for measurement properties such as size, margins, etc., in a Word document? -Java Word library uses Points for measurement properties in a Word document. +The Java Word library uses Points for measurement properties in a Word document. ## Migration from Microsoft Office Automation to Essential® DocIO diff --git a/java-file-formats/word-library/find-item-in-word-document.md b/java-file-formats/word-library/find-item-in-word-document.md index 9dabab1..3fb2f9c 100644 --- a/java-file-formats/word-library/find-item-in-word-document.md +++ b/java-file-formats/word-library/find-item-in-word-document.md @@ -8,16 +8,16 @@ documentation: UG # Find item in Word document -Just like you can search for a text in a Word document, you can also search for an item (like image, content control, textbox, and so on). The Java Word library supports to find an item in Word document based on its properties. With this functionality, you can: +Just like you can search for a text in a Word document, you can also search for an item (like image, content control, textbox, and so on). The Java Word library supports finding an item in Word document based on its properties. With this functionality, you can: * Find the first item based on one property. -* Find the first item based on multiple properties +* Find the first item based on multiple properties. * Find all the items based on one property. * Find all the items based on multiple properties. ## Find item by property -Using findItemByProperty API, find the first item in the Word document that has the specified property name and value. +Using `findItemByProperty` API, find the first item in the Word document that has the specified property name and value. The following code example illustrates how to find the first item based on one property. @@ -44,7 +44,7 @@ document.close(); ## Find item by properties -Using findItemByProperties API, find the first item in the Word document based on multiple property names and their corresponding values. +Using `findItemByProperties` API, find the first item in the Word document based on multiple property names and their corresponding values. The following code example illustrates how to find the first item in Word document based on multiple property names and their corresponding values. @@ -70,7 +70,7 @@ document.close(); ## Find all items by property -Using findAllItemsByProperty API, find all the items in the Word document that has the specified property name and value. +Using `findAllItemsByProperty` API, find all the items in the Word document that has the specified property name and value. The following code example illustrates how to find all the items in Word document based on one property. @@ -108,7 +108,7 @@ document.close(); ## Find all items by properties -Using findAllItemsByProperties API, find all the items in the Word document based on multiple property names and their corresponding values. +Using `findAllItemsByProperties` API, find all the items in the Word document based on multiple property names and their corresponding values. The following code example illustrates how to find all the items in Word document based on multiple property names and their corresponding values. @@ -156,4 +156,4 @@ document.close(); {% endtabs %} -T> Passing null for both the property names and property values in the above APIs, you can also find an item in a Word document without relying on any property. \ No newline at end of file +T> Passing null for both the property names and property values in the above APIs, you can also find an item in a Word document without relying on any property. diff --git a/java-file-formats/word-library/getting-started.md b/java-file-formats/word-library/getting-started.md index 6432c65..170a4ce 100644 --- a/java-file-formats/word-library/getting-started.md +++ b/java-file-formats/word-library/getting-started.md @@ -1,6 +1,6 @@ --- title: Create a simple Word document in Java | Syncfusion -description: This section illustrate how to create a new Word document from scratch in Java using Syncfusion Java Word library (Essential DocIO) +description: This section illustrates how to create a new Word document from scratch in Java using the Syncfusion Java Word library (Essential DocIO). platform: java-file-formats control: Word Library documentation: UG @@ -19,6 +19,8 @@ Before you begin, make sure your development environment meets the following req * **Syncfusion license key:** Required from v19.1.0.x onward. See the [licensing overview](https://help.syncfusion.com/common/essential-studio/licensing/overview). * **Java IDE:** Eclipse, IntelliJ IDEA, or any editor of your choice. +N> The Syncfusion Java Word library (Essential DocIO) is also required to be referenced in your application. The jar files listed below contain the core features needed for creating, reading, and manipulating a Word document. + @@ -92,11 +94,11 @@ The following code example explains how to add a section into a `WordDocument` i {% tabs %} {% highlight JAVA %} -//Create an instance of WordDocument Instance (Empty Word Document). +//Create a WordDocument instance (empty Word document). WordDocument document = new WordDocument(); //Add a new section into the Word document. IWSection section = document.addSection(); -//Specifies the page margins. +//Specify the page margins. section.getPageSetup().getMargins().setAll(50); {% endhighlight %} @@ -133,7 +135,7 @@ The following code example shows how to add an image into the Word document. {% tabs %} {% highlight JAVA %} -//Add another paragraph and aligns it as a center. +//Add another paragraph and align it as center. IWParagraph paragraph = section.addParagraph(); paragraph.getParagraphFormat().setHorizontalAlignment(HorizontalAlignment.Center); //Set after spacing for paragraph. @@ -158,13 +160,13 @@ IWTable table = section.addTable(); table.resetCells(2,2); //Access the instance of the cell (first row, first cell). WTableCell firstCell = table.getRows().get(0).getCells().get(0); -//Specifies the width of the cell. +//Specify the width of the cell. firstCell.setWidth(150); -//Add a paragraph into the cell; a cell must have atleast 1 paragraph. +//Add a paragraph into the cell; a cell must have at least one paragraph. paragraph=firstCell.addParagraph(); IWTextRange textRange = paragraph.appendText("Profile picture"); textRange.getCharacterFormat().setBold(true); -//Access the instance of cell (first row, second cell). +//Access the instance of the cell (first row, second cell). WTableCell secondCell = table.getRows().get(0).getCells().get(1); secondCell.setWidth(330); paragraph=secondCell.addParagraph(); @@ -260,12 +262,12 @@ section.addParagraph(); {% endtabs %} -Finally, save the document in the file system and close its instance. +Finally, save the document to the file system and close its instance. {% tabs %} {% highlight JAVA %} -//Save the document in the given name and format. -document.save(outputFileName,FormatType.Docx); +//Save the document with the given name and format. +document.save("Result.docx", FormatType.Docx); //Release the resources occupied by the WordDocument instance. document.close(); {% endhighlight %} @@ -279,7 +281,7 @@ The resultant Word document looks as follows. ## Performing Mail merge -Essential® DocIO allows you to generate documents by filling data in the template document from the data source. Mail merge operation automatically maps the column name in the data source and names of the merge fields in the template Word document and fills the data. +Essential® DocIO allows you to generate documents by filling data into the template document from a data source. The Mail merge operation automatically maps the column names in the data source to the merge-field names in the template Word document and fills the data. The following data sources are supported by the Essential® DocIO for performing the Mail merge. @@ -287,7 +289,7 @@ The following data sources are supported by the Essential employeeList = getEmployees(); -//Uses the mail merge events handler for image fields. +//Use the mail merge event handler for image fields. document.getMailMerge().MergeImageField.add("mergeField_EmployeeImage", new MergeImageFieldEventHandler() { ListSupport delegateList = new ListSupport( MergeImageFieldEventHandler.class); -//Represents event handling for MergeFieldEventHandlerCollection. +//Handles the MergeImageField event. public void invoke(Object sender, MergeImageFieldEventArgs args) throws Exception { mergeField_EmployeeImage(sender, args); } -//Represents the method that handles MergeField event. +//Dynamically invokes the MergeImageField event. public void dynamicInvoke(Object... args) throws Exception { mergeField_EmployeeImage((Object) args[0], (MergeImageFieldEventArgs) args[1]); } -//Represents the method that handles MergeField event to add collection item. +//Adds a delegate to the MergeImageField event handler collection. public void add(MergeImageFieldEventHandler delegate) throws Exception { if (delegate != null) delegateList.add(delegate); } -//Represents the method that handles MergeField event to remove collection item. +//Removes a delegate from the MergeImageField event handler collection. public void remove(MergeImageFieldEventHandler delegate) throws Exception { if (delegate != null) delegateList.remove(delegate); } }); -//Creates an instance of MailMergeDataTable by specifying MailMerge group name and IEnumerable collection. -MailMergeDataTable dataSource = new MailMergeDataTable("Employees",employeeList); -//Executes the mail merge for group. +//Creates an instance of MailMergeDataTable by specifying the MailMerge group name and the list. +MailMergeDataTable dataSource = new MailMergeDataTable("Employees", employeeList); +//Executes the mail merge for the group. document.getMailMerge().executeGroup(dataSource); //Saves and closes the WordDocument instance. -document.save("Sample.docx"); +document.save("Result.docx"); document.close(); {% endhighlight %} {% endtabs %} -The following code example shows getEmployees method which is used to get data for mail merge. +The following code example shows the `getEmployees` method, which is used to get data for mail merge. {% tabs %} @@ -403,7 +407,7 @@ public ListSupport getEmployees()throws Exception {% endtabs %} -The following code example shows how to bind the image from file system during Mail merge process by using MergeImageFieldEventHandler. +The following code example shows how to bind an image from the file system during the Mail merge process by using the `MergeImageFieldEventHandler`. {% tabs %} @@ -413,9 +417,9 @@ private void mergeField_EmployeeImage(Object sender, MergeImageFieldEventArgs ar //Binds image from file system during mail merge. if ((args.getFieldName()).equals("Photo")) { - String ProductFileName = args.getFieldValue().toString(); + String productFileName = args.getFieldValue().toString(); //Gets the image from file system. - FileStreamSupport imageStream = new FileStreamSupport(ProductFileName, FileMode.Open, FileAccess.Read); + FileStreamSupport imageStream = new FileStreamSupport(productFileName, FileMode.Open, FileAccess.Read); ByteArrayInputStream stream = new ByteArrayInputStream(imageStream.toArray()); args.setImageStream(stream); } @@ -425,7 +429,7 @@ private void mergeField_EmployeeImage(Object sender, MergeImageFieldEventArgs ar {% endtabs %} -The following code example provides supporting class for the above code. +The following code example provides the supporting class for the above code. {% tabs %} {% highlight JAVA %} @@ -508,7 +512,7 @@ public class Employee public String setPhoto(String image)throws Exception { _photo=image; - return image; + return image; } public Employee(String firstName,String lastName,String title,String address,String city,String region,String country,String photoFilePath)throws Exception { diff --git a/java-file-formats/word-library/html.md b/java-file-formats/word-library/html.md index 8319333..10ea758 100644 --- a/java-file-formats/word-library/html.md +++ b/java-file-formats/word-library/html.md @@ -8,28 +8,28 @@ documentation: UG # Word to HTML and HTML to Word Conversions -The Essential® DocIO converts the HTML file into a Word document and vice versa. You can also convert the Word document (DOCX, DOTX, DOCM, and DOTM) into HTML format. +The Essential® DocIO converts an HTML file into a Word document and vice versa. You can also convert a Word document (DOCX, DOTX, DOCM, and DOTM) into HTML format. -In the Word library (DocIO) we use the [XmlReader](https://learn.microsoft.com/en-us/dotnet/api/system.xml.xmlreader?view=netframework-4.8) for parsing the content from input HTML. So, the input HTML should meet the XML standard (have proper open and close tags), even if you specify the `XHTMLValidationType` parameter as `XHTMLValidationType.None`. +In the Word library (DocIO), the content from the input HTML is parsed using XML parsing APIs. So, the input HTML should meet the XML standard (have proper open and close tags), even if you specify the `XHTMLValidationType` parameter as `XHTMLValidationType.None`. ## XHTML Validation -Every HTML content is validated against a Document Type Declaration (DTD) which is a set of mark-up declarations that define a document type for a SGML-family mark-up language (GML, SGML, XML, HTML). +Every HTML content is validated against a Document Type Declaration (DTD), which is a set of mark-up declarations that define a document type for an SGML-family mark-up language (GML, SGML, XML, HTML). ### XHTML validation types -The following XHTML validation types are supported in Essential® DocIO while importing an HTML content. +The following XHTML validation types are supported in Essential® DocIO while importing HTML content.
- - + + - + @@ -41,7 +41,7 @@ The following XHTML validation types are supported in Essential
 +Text input, checkbox, and combo box

+Only the odd header of the first section is preserved in HTML export.

diff --git a/java-file-formats/word-library/supported-latex.md b/java-file-formats/word-library/supported-latex.md index da3cf4c..88b45d6 100644 --- a/java-file-formats/word-library/supported-latex.md +++ b/java-file-formats/word-library/supported-latex.md @@ -1,17 +1,18 @@ --- title: Supported LaTeX | DocIO | Syncfusion -description: Learn the list of LaTeX supported by Java Word library while creating equation in Word document. +description: Learn the list of LaTeX supported by the Java Word library while creating equations in a Word document. platform: java-file-formats control: Word Library documentation: UG --- # Supported symbols using LaTeX in Word Library -The Java Word library allows to insert below supported symbols in equation using **LaTeX**. + +The Java Word library supports inserting the following symbols in equations using **LaTeX**. ## Arrows -The following image demonstrates the LaTeX supported in Java Word library to create arrow symbols. +The following images demonstrate the LaTeX supported by the Java Word library to create arrow symbols. ![Create Arrow Symbols in LaTeX](WorkingwithMathematicalEquation_images/ArrowsInLaTex_1.png) ![Create Arrow Symbols in LaTeX](WorkingwithMathematicalEquation_images/ArrowsInLaTex_2.png) @@ -21,7 +22,7 @@ The following image demonstrates the LaTeX supported in Java Word library to cre ## Basic Math -The following image demonstrates the LaTeX supported in Java Word library to create basic math symbols. +The following images demonstrate the LaTeX supported by the Java Word library to create basic math symbols. ![Create Basic Math Symbols in LaTeX](WorkingwithMathematicalEquation_images/BasicMath_1.png) ![Create Basic Math Symbols in LaTeX](WorkingwithMathematicalEquation_images/BasicMath_2.png) @@ -30,7 +31,7 @@ The following image demonstrates the LaTeX supported in Java Word library to cre ## Geometry -The following image demonstrates the LaTeX equivalent to geometry. +The following image demonstrates the LaTeX equivalent for geometry. ![Create Geometry Symbols in LaTeX](WorkingwithMathematicalEquation_images/Geometry.png) @@ -38,28 +39,28 @@ The following image demonstrates the LaTeX equivalent to geometry. ### Lower Case -The following image demonstrates the LaTeX supported in Java Word library to create lower case Greek letters. +The following images demonstrate the LaTeX supported by the Java Word library to create lower-case Greek letters. ![Create Lower Case Symbols in LaTeX](WorkingwithMathematicalEquation_images/GreekLetter_LowerCase_1.png) ![Create Lower Case Symbols in LaTeX](WorkingwithMathematicalEquation_images/GreekLetter_LowerCase_2.png) ### Upper Case -The following image demonstrates the LaTeX supported in Java Word library to create upper case Greek letters. +The following images demonstrate the LaTeX supported by the Java Word library to create upper-case Greek letters. ![Create Upper Case Symbols in LaTeX](WorkingwithMathematicalEquation_images/GreekLetter_UpperCase_1.png) ![Create Upper Case Symbols in LaTeX](WorkingwithMathematicalEquation_images/GreekLetter_UpperCase_2.png) ## Letter-Like Symbols -The following image demonstrates the LaTeX supported in Java Word library to create letter-like symbols. +The following images demonstrate the LaTeX supported by the Java Word library to create letter-like symbols. ![Create Letter-Like Symbols in LaTeX](WorkingwithMathematicalEquation_images/LetterLikeSymbols_1.png) ![Create Letter-Like Symbols in LaTeX](WorkingwithMathematicalEquation_images/LetterLikeSymbols_2.png) ## Negated Relations -The following image demonstrates the LaTeX supported in Java Word library to create negated relations. +The following images demonstrate the LaTeX supported by the Java Word library to create negated relations. ![Create Negated Relations Symbols in LaTeX](WorkingwithMathematicalEquation_images/NegatedRelation_1.png) ![Create Negated Relations Symbols in LaTeX](WorkingwithMathematicalEquation_images/NegatedRelation_2.png) @@ -69,14 +70,14 @@ The following image demonstrates the LaTeX supported in Java Word library to cre ### Common Binary Operators -The following image demonstrates the LaTeX supported in Java Word library to create common binary operators. +The following images demonstrate the LaTeX supported by the Java Word library to create common binary operators. ![Create Common Binary Operators Symbols in LaTeX](WorkingwithMathematicalEquation_images/CommonBinaryOperator_1.png) ![Create Common Binary Operators Symbols in LaTeX](WorkingwithMathematicalEquation_images/CommonBinaryOperator_2.png) ### Common Relational Operators -The following image demonstrates the LaTeX supported in Java Word library to common relational operators. +The following images demonstrate the LaTeX supported by the Java Word library to create common relational operators. ![Create Common Relational Operators Symbols in LaTeX](WorkingwithMathematicalEquation_images/CommonRelationalOperator_1.png) ![Create Common Relational Operators Symbols in LaTeX](WorkingwithMathematicalEquation_images/CommonRelationalOperator_2.png) @@ -84,14 +85,14 @@ The following image demonstrates the LaTeX supported in Java Word library to com ### Basic N-ary Operators -The following image demonstrates the LaTeX supported in Java Word library to basic N-ary operators. +The following images demonstrate the LaTeX supported by the Java Word library to create basic N-ary operators. ![Create Basic N-ary Operators Symbols in LaTeX](WorkingwithMathematicalEquation_images/BinaryN-aryOperator_1.png) ![Create Basic N-ary Operators Symbols in LaTeX](WorkingwithMathematicalEquation_images/BinaryN-aryOperator_2.png) ### Advanced Binary Operators -The following image demonstrates the LaTeX supported in Java Word library to advanced binary operators. +The following images demonstrate the LaTeX supported by the Java Word library to create advanced binary operators. ![Create Advanced Binary Symbols in LaTeX](WorkingwithMathematicalEquation_images/AdvancedBinaryOperator_1.png) ![Create Advanced Binary Symbols in LaTeX](WorkingwithMathematicalEquation_images/AdvancedBinaryOperator_2.png) @@ -99,7 +100,7 @@ The following image demonstrates the LaTeX supported in Java Word library to adv ### Advanced Relational Operators -The following image demonstrates the LaTeX supported in Java Word library to advanced relational operators. +The following images demonstrate the LaTeX supported by the Java Word library to create advanced relational operators. ![Create Advanced Relational Symbols in LaTeX](WorkingwithMathematicalEquation_images/AdvancedRelationalOperator_1.png) ![Create Advanced Relational Symbols in LaTeX](WorkingwithMathematicalEquation_images/AdvancedRelationalOperator_2.png) diff --git a/java-file-formats/word-library/text.md b/java-file-formats/word-library/text.md index c8fdd03..ae0cba3 100644 --- a/java-file-formats/word-library/text.md +++ b/java-file-formats/word-library/text.md @@ -8,7 +8,7 @@ documentation: UG # Word to Text and Text to Word Conversions -The Essential® DocIO converts the Word document into the Text file and vice versa. The following code example shows how to convert the Word document into text file. +The Essential® DocIO converts a Word document into a text file and vice versa. The following code example shows how to convert a Word document into a text file. {% tabs %} {% highlight JAVA %} @@ -27,7 +27,7 @@ The following code example shows how to convert a text file into a Word document {% highlight JAVA %} //Load a text file. WordDocument document = new WordDocument("Template.txt"); -//Save the document as a text file. +//Save the document as a Word file. document.save("TextToWord.docx", FormatType.Docx); //Close the document. document.close(); diff --git a/java-file-formats/word-library/word-document/compare-word-documents.md b/java-file-formats/word-library/word-document/compare-word-documents.md index ed010dd..923c59c 100644 --- a/java-file-formats/word-library/word-document/compare-word-documents.md +++ b/java-file-formats/word-library/word-document/compare-word-documents.md @@ -14,11 +14,11 @@ Comparing two Word documents allows you to identify the changes between two vers * Formatting N> 1. DocIO performs word level comparison while comparing two Word documents. In this scenario, if a single character in a word is changed, the entire word will be highlighted as changed. -N> 2. Comparing two Word documents supported in DOCX format only. +N> 2. Comparing two Word documents is supported in DOCX format only. -## Compare two Word documents +## Compare two Word documents -Compare the existing Word documents or documents created from scratch using the ``Compare`` method in the Java Word library (DocIO). +You can compare existing Word documents or documents created from scratch using the `Compare` method in the Java Word library (DocIO). The following code example illustrates how to compare two Word documents. @@ -44,9 +44,9 @@ revisedDocument.close(); ![Compare Word documents in Java](../WorkingwithWordDocument_images/Compare-Word-documents-without-author.png) -## Set Author and Date +## Set Author and Date -Compare the two Word documents by setting the author and date for revisions to identify the changes. In DocIO, the default setting for the “author” field is “Author”, and the default setting for the “dateTime” field is the current time. +You can compare two Word documents by setting the author and date for revisions to identify the changes. In DocIO, the default setting for the "author" field is "Author", and the default setting for the "dateTime" field is the current time. The following code example shows how to set the author and date for revision while comparing two Word documents. @@ -74,7 +74,7 @@ revisedDocument.close(); ## Comparison options -You can customize the Word comparison using our ``ComparisonOptions`` in the DocIO. +You can customize the Word comparison using the `ComparisonOptions` in the DocIO. ### Ignore format changes diff --git a/java-file-formats/word-library/word-file-formats.md b/java-file-formats/word-library/word-file-formats.md index eba7760..3446067 100644 --- a/java-file-formats/word-library/word-file-formats.md +++ b/java-file-formats/word-library/word-file-formats.md @@ -72,10 +72,10 @@ DOCM is a macro-enabled Word document. It is same as the DOCX document contains WordDocument document = new WordDocument("Template.dotm"); // Get the table. DataTableSupport table = getDataTable(); -// Execute the Mail Mmrge with groups. +// Execute the Mail Merge with groups. document.getMailMerge().executeGroup(table); //Save and close the document. -document.save("Sample.docm", FormatType.Word2013Docm); +document.save("Sample.docm", FormatType.Docm); document.close(); {% endhighlight %} {% endtabs %} diff --git a/java-file-formats/word-library/working-with-bookmarks.md b/java-file-formats/word-library/working-with-bookmarks.md index fd47a59..9f5b072 100644 --- a/java-file-formats/word-library/working-with-bookmarks.md +++ b/java-file-formats/word-library/working-with-bookmarks.md @@ -9,7 +9,7 @@ documentation: UG A bookmark identifies a location or a selection of text within a document that you can name and identify for future reference. -In Essential® DocIO, bookmark is represented by Bookmark instance that is a pair of BookmarkStart and BookmarkEnd. BookmarkStart represents start point of a bookmark and BookmarkEnd represents end point of a bookmark. Every Word document contains a collection of bookmarks that are accessible through the Bookmarks property of WordDocument class. +In Essential® DocIO, a bookmark is represented by a Bookmark instance that is a pair of BookmarkStart and BookmarkEnd. BookmarkStart represents the start point of a bookmark and BookmarkEnd represents the end point of a bookmark. Every Word document contains a collection of bookmarks that are accessible through the Bookmarks property of WordDocument class. ## Adding a bookmark @@ -238,6 +238,8 @@ public IWTable CreateTable(WordDocument document) throws Exception You can insert table, paragraph, simple text and paragraph item at the start or end location of the current bookmark by using bookmark navigator. +You can insert table, paragraph, simple text and paragraph item at the start or end location of the current bookmark by using bookmark navigator. + The following code example shows how to insert a simple text by using BookmarkNavigator. {% tabs %} @@ -292,8 +294,6 @@ The following code example shows how to insert a paragraph by using BookmarkNavi {% highlight JAVA %} //Load the template document with bookmark "Northwind". WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); -//Load the template document with bookmark "Northwind". -WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); //Create the bookmark navigator instance to access the bookmark. BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); //Move the virtual cursor to the location before the end of the bookmark "Northwind". diff --git a/java-file-formats/word-library/working-with-comments.md b/java-file-formats/word-library/working-with-comments.md index 5a64445..6d4c027 100644 --- a/java-file-formats/word-library/working-with-comments.md +++ b/java-file-formats/word-library/working-with-comments.md @@ -1,15 +1,15 @@ --- title: Working with Comments | Syncfusion -description: This section illustrates about working with comments in the Word document without MS Word or Office interop +description: This section illustrates how to work with comments in a Word document without MS Word or Office interop platform: java-file-formats control: Word Library documentation: UG --- # Working with Comments -A comment is a note or annotation that an author or reviewer can add to a document. DocIO represents comment with `WComment` instance. +A comment is a note or annotation that an author or reviewer can add to a document. DocIO represents a comment with a `WComment` instance. -N> The comment start and end ranges and dates can be preserved only on processing an existing document that already contains these information for each comment. +N> The comment start and end ranges and dates can be preserved only on processing an existing document that already contains this information for each comment. ## Adding a Comment @@ -33,7 +33,7 @@ WComment comment = paragraph.appendComment("comment test"); comment.getFormat().setUser("Peter"); //Specifies the initial of the author. comment.getFormat().setUserInitials("St"); -//Set the date and time for comment. +//Sets the date and time for the comment. comment.getFormat().setDateTime(LocalDateTime.now()); //Saves the Word document. document.save("Comment.docx", FormatType.Docx); @@ -83,7 +83,7 @@ WordDocument document = new WordDocument("Comment.docx", FormatType.Docx); document.getComments().clear(); //Saves the Word document. document.save("Result.docx", FormatType.Docx); -//Closes the document +//Closes the document. document.close(); {% endhighlight %} @@ -96,32 +96,32 @@ The following code shows how to remove a particular comment from Word document. {% highlight JAVA %} //Opens the template document. WordDocument document = new WordDocument("Comments.docx", FormatType.Docx); -//Removes second comments from a document. +//Removes the second comment from a document. document.getComments().removeAt(1); //Saves the Word document. document.save("Result.docx", FormatType.Docx); -//Closes the document +//Closes the document. document.close(); {% endhighlight %} {% endtabs %} -##Accessing parent comment +## Accessing parent comment -You can access the parent comment of a particular comment (reply) in a Word document using `getAncestor()` API. The ancestor for parent comment returns `null` as default. +You can access the parent comment of a particular comment (reply) in a Word document using the `getAncestor()` API. The ancestor for a parent comment returns `null` by default. -The following code examples show how to access the parent comment of a particular comment in a Word document. +The following code example shows how to access the parent comment of a particular comment in a Word document. {% tabs %} {% highlight JAVA %} -//Create an empty WordDocument instance. +//Creates an empty WordDocument instance. WordDocument document = new WordDocument(); -//open an existing Word document using the Open method of WordDocument class. +//Opens an existing Word document using the Open method of the WordDocument class. document.open("Comments.docx"); -//Get the Ancestor comment. +//Gets the ancestor comment. WComment ancestorComment = document.getComments().get(1).getAncestor(); -//Save and Close the Word document. +//Saves and closes the Word document. document.save("Result.docx", FormatType.Docx); document.close(); {% endhighlight %} diff --git a/java-file-formats/word-library/working-with-content-controls.md b/java-file-formats/word-library/working-with-content-controls.md index b1aa231..8644b18 100644 --- a/java-file-formats/word-library/working-with-content-controls.md +++ b/java-file-formats/word-library/working-with-content-controls.md @@ -1,6 +1,6 @@ --- title: Working with Content Controls | Word library | Syncfusion -description: This section illustrates how to work with Content Controls in Word document using Syncfusion Java Word library (Essential DocIO) +description: This section illustrates how to work with Content Controls in a Word document using the Syncfusion Java Word library (Essential DocIO) platform: java-file-formats control: Word Library documentation: UG @@ -14,14 +14,14 @@ Content controls are individual controls that you can add and customize to use i N> You can use content controls only in documents that are saved in the Open XML Format. -Content controls can be categorized based on its occurrence in a document as follows, +Content controls can be categorized based on their occurrence in a document as follows: -* InlineContentControl: Among inline content inside, as a child of a paragraph. +* InlineContentControl: Among inline content, as a child of a paragraph. * BlockContentControl: Among paragraphs and tables, as a child of a Body, HeaderFooter, Comment, Footnote, or a Shape node. ### Block Content Control -You can add content control to a text body of the Word document using block content control. You can add text, tables, pictures, or other items into the block content control. Refer to the following code. +You can add content control to a text body of the Word document using the block content control. You can add text, tables, pictures, or other items into the block content control. Refer to the following code. {% tabs %} {% highlight JAVA %} @@ -52,7 +52,7 @@ document.close(); ### Inline Content Control -You can add content control as a child to a paragraph using the inline content control. You can add text, pictures, fields or other paragraph items into the inline content control. Refer to the following code. +You can add content control as a child to a paragraph using the inline content control. You can add text, pictures, fields, or other paragraph items into the inline content control. Refer to the following code. {% tabs %} {% highlight JAVA %} @@ -95,27 +95,27 @@ The tag value to identify the content control. This property allows you to define the appearance of the content controls. The appearance can be any one of the following: -* BoundingBox: Displays the contents of content control within a box. -* Tags: Displays the contents of content control within tags. -* Hidden: Displays the contents of content control without any box or tags. +* BoundingBox: Displays the contents of the content control within a box. +* Tags: Displays the contents of the content control within tags. +* Hidden: Displays the contents of the content control without any box or tags. ### Color Defines the color of the content control. -### Temporary +### Temporary This property defines whether to remove a content control from the Word document when you edit the contents of the content control. ### Lock Contents -Locking the contents of the content control. It restricts to modify the contents of the content control. +Locks the contents of the content control. It restricts modification of the contents of the content control. ### Lock Content Control -It restricts to remove or delete the content control. +It restricts removal or deletion of the content control. -### Example – Content Control Common properties +### Example – Content Control Common Properties The following code sample illustrates the content control properties usage. @@ -166,7 +166,7 @@ The content controls have the following three major use cases: ### Protection -Content controls provides options to prevent users from editing or deleting parts of a Word document contents. This is useful if you have information in a Word document or template that you should be able to read but not edit, or if you want to be able to edit content controls but not delete them. +Content controls provide options to prevent users from editing or deleting parts of a Word document's contents. This is useful if you have information in a Word document or template that you should be able to read but not edit, or if you want to be able to edit content controls but not delete them. To protect contents inside a content control, you can use properties of the content control to prevent editing or deleting the content control: diff --git a/java-file-formats/word-library/working-with-fields.md b/java-file-formats/word-library/working-with-fields.md index 113ee48..4dcd2d4 100644 --- a/java-file-formats/word-library/working-with-fields.md +++ b/java-file-formats/word-library/working-with-fields.md @@ -5,13 +5,13 @@ platform: java-file-formats control: Word Library documentation: UG --- -# Working with document Fields +# Working with Fields Fields in a Word document are placeholders for data that might change on field update. Fields are represented by the `WField` and `WFieldMark` instances in DocIO. A field in a Word document contains field codes, field separator, field result, and field end. -To learn various types of Microsoft Word supported fields and their syntax,refer to the [MSDN article](https://support.microsoft.com/en-us/office/list-of-field-codes-in-word-1ad6d91a-55a7-4a8d-b535-cf7888659a51?ui=en-us&rs=en-us&ad=us#) +To learn various types of Microsoft Word supported fields and their syntax, refer to the [MSDN article](https://support.microsoft.com/en-us/office/list-of-field-codes-in-word-1ad6d91a-55a7-4a8d-b535-cf7888659a51?ui=en-us&rs=en-us&ad=us#). -The entire field code is included in Document Object Model(DOM). Hence, adding a field will automatically include the following elements in DOM: +The entire field code is included in Document Object Model (DOM). Hence, adding a field will automatically include the following elements in DOM: 1. `WField`: Represents the starting of a Field. @@ -126,7 +126,7 @@ document.close(); IF field compares two values and updates the field result with true text, when comparison succeeds otherwise false text. -To learn more about IF field and its syntax in Microsoft Word, refer to the [MSDN article](https://support.office.com/en-au/article/Field-codes-IF-field-9f79e82f-e53b-4ff5-9d2c-ae3b22b7eb5e#) +To learn more about IF field and its syntax in Microsoft Word, refer to the [MSDN article](https://support.office.com/en-au/article/Field-codes-IF-field-9f79e82f-e53b-4ff5-9d2c-ae3b22b7eb5e). The following code example explains how to add an If field to a Word document. @@ -263,20 +263,22 @@ document.close(); N> XE (Index Entry) fields cannot be unlinked. ## Sequence Field -You can use the Sequence (SEQ) field to automatically numbers the chapters, tables, figures, and other items in a Word document. When you add, delete, or move an item in Word document (along with SEQ fields), you can update the remaining SEQ fields with a new sequence. -You can format the SEQ field using below switches. +You can use the Sequence (SEQ) field to automatically number the chapters, tables, figures, and other items in a Word document. When you add, delete, or move an item in the Word document (along with SEQ fields), you can update the remaining SEQ fields with a new sequence. -\c -- Repeats the closest preceding sequence number. -\h -- Hides the field result unless a general-formatting-switch is also present. -\n -- Inserts the next sequence number for the specified items. This is the default switch. -\r -- Resets the sequence number to the number following “r”. -\s -- Resets the sequence number at the heading level following the "s". +You can format the SEQ field using the following switches: -### Apply Number format -You can apply the number format for the sequence field using `NumberFormat` property. +* `\c` — Repeats the closest preceding sequence number. +* `\h` — Hides the field result unless a general-formatting-switch is also present. +* `\n` — Inserts the next sequence number for the specified items. This is the default switch. +* `\r` — Resets the sequence number to the number following "r". +* `\s` — Resets the sequence number at the heading level following "s". -The following code example shows how to apply the number format for sequence field. +### Apply Number Format + +You can apply the number format for the sequence field using `NumberFormat` property. + +The following code example shows how to apply the number format for the sequence field. {% tabs %} @@ -298,7 +300,7 @@ field.setNumberFormat(CaptionNumberingFormat.Roman); //Updates the document fields. document.updateDocumentFields(); //Saves and closes the Word document. -document.save("Sample.docx"); +document.save("Sample.docx", FormatType.Docx); document.close(); {% endhighlight %} @@ -403,8 +405,8 @@ field = ((WSeqField)((WParagraph)table.get(0,1).getChildEntities().get(1)).getCh field.setResetHeadingLevel(1); //Updates the document fields. document.updateDocumentFields(); -//Saves and closes the Word document. -document.save("Sample.docx"); +//Saves and closes the Word document. +document.save("Sample.docx", FormatType.Docx); document.close(); {% endhighlight %} diff --git a/java-file-formats/word-library/working-with-find-and-replace.md b/java-file-formats/word-library/working-with-find-and-replace.md index d94dc28..521285e 100644 --- a/java-file-formats/word-library/working-with-find-and-replace.md +++ b/java-file-formats/word-library/working-with-find-and-replace.md @@ -1,17 +1,17 @@ --- title: Working with Find and Replace | Syncfusion -description: This section illustrates finding a text and replacing it with a new text in a Word document without Microsoft Word or Office interop +description: This section illustrates how to find a text and replace it with a new text in a Word document without Microsoft Word or Office interop platform: java-file-formats control: Word Library documentation: UG --- # Working with Find and Replace -You can search a particular text you like to change and replace it with another text or part of the document. +You can search for a particular text you like to change and replace it with another text or part of the document. ## Finding contents in a Word document -You can find the first occurrence of a particular text within a single paragraph in the document by using `Find` method and its next occurrence by using `FindNext` method. You can also find a particular text pattern in the document. +You can find the first occurrence of a particular text within a single paragraph in the document by using the `find` method and its next occurrence by using the `findNext` method. You can also find a particular text pattern in the document. The following code example illustrates how to find a particular text and its next occurrence in the document. @@ -20,81 +20,81 @@ The following code example illustrates how to find a particular text and its nex {% highlight JAVA %} //Loads the template document WordDocument document = new WordDocument("Template.docx", FormatType.Docx); -//Finds the first occurrence of a particular text in the document +//Finds the first occurrence of a particular text in the document. TextSelection textSelection = document.find("as graphical contents", false, true); -//Gets the found text as single text range +//Gets the found text as a single text range. WTextRange textRange = textSelection.getAsOneRange(); -//Modifies the text +//Modifies the text. textRange.setText("Replaced text"); -//Sets highlight color +//Sets the highlight color. textRange.getCharacterFormat().setHighlightColor(ColorSupport.getYellow()); -//Finds the next occurrence of a particular text from the previous paragraph +//Finds the next occurrence of a particular text from the previous paragraph. textSelection = document.findNext(textRange.getOwnerParagraph(), "paragraph", true, false); -//Gets the found text as single text range +//Gets the found text as a single text range. WTextRange range = textSelection.getAsOneRange(); -//Sets bold formatting +//Sets bold formatting. range.getCharacterFormat().setBold(true); -//Saves and closes the document +//Saves and closes the document. document.save("Sample.docx", FormatType.Docx); document.close(); {% endhighlight %} {% endtabs %} -You can find all the occurrence of a particular text within a single paragraph in the document by using `FindAll` method. +You can find all the occurrences of a particular text within a single paragraph in the document by using the `findAll` method. The following code example illustrates how to find all the occurrences of a particular text in the document. {% tabs %} {% highlight JAVA %} -//Loads the template document +//Loads the template document. WordDocument document = new WordDocument("Template.docx", FormatType.Docx); -//Finds all the occurrences of a particular text -TextSelection[] textSelections = document.findAll("paragraph",false,true); +//Finds all the occurrences of a particular text. +TextSelection[] textSelections = document.findAll("paragraph", false, true); for(Object textSelection_tempObj : textSelections) { TextSelection textSelection = (TextSelection)textSelection_tempObj; WTextRange textRange = textSelection.getAsOneRange(); textRange.getCharacterFormat().setHighlightColor(ColorSupport.getYellowGreen()); } -//Saves and closes the document +//Saves and closes the document. document.save("Sample.docx", FormatType.Docx); document.close(); {% endhighlight %} {% endtabs %} -You can find the first occurrence of a particular text extended to several paragraphs in the document by using `FindSingleLine` method and its next occurrence by using `FindNextSingleLine` method. +You can find the first occurrence of a particular text extended to several paragraphs in the document by using the `findSingleLine` method and its next occurrence by using the `findNextSingleLine` method. The following code example illustrates how to find a particular text extended to several paragraphs in the Word document. {% tabs %} {% highlight JAVA %} -//Loads the template document +//Loads the template document. WordDocument document = new WordDocument("Template.docx", FormatType.Docx); -//Finds the first occurrence of a particular text extended to several paragraphs in the document +//Finds the first occurrence of a particular text extended to several paragraphs in the document. TextSelection[] textSelections = document.findSingleLine("First paragraph Second paragraph", true, false); WParagraph paragraph = null; for(Object textSelection_tempObj : textSelections) { - //Gets the found text as single text range and set highlight color + //Gets the found text as a single text range and sets the highlight color. TextSelection textSelection = (TextSelection)textSelection_tempObj; WTextRange textRange = textSelection.getAsOneRange(); textRange.getCharacterFormat().setHighlightColor(ColorSupport.getYellowGreen()); paragraph=textRange.getOwnerParagraph(); } -//Finds the next occurrence of a particular text extended to several paragraphs in the document +//Finds the next occurrence of a particular text extended to several paragraphs in the document. textSelections=document.findNextSingleLine(paragraph,"First paragraph Second paragraph",true,false); for(Object textSelection_tempObj : textSelections) { - //Gets the found text as single text range and sets italic formatting + //Gets the found text as a single text range and sets italic formatting. TextSelection textSelection = (TextSelection)textSelection_tempObj; WTextRange text = textSelection.getAsOneRange(); text.getCharacterFormat().setItalic(true); } -//Saves and closes the document +//Saves and closes the document. document.save("Sample.docx", FormatType.Docx); document.close(); {% endhighlight %} @@ -110,11 +110,11 @@ The following code example illustrates how to replace all occurrences of a missp {% tabs %} {% highlight JAVA %} -// Opens the input Word document +//Opens the input Word document. WordDocument document = new WordDocument("Template.docx"); -// Finds all occurrences of a misspelled word and replaces with properly spelled word +//Finds all occurrences of a misspelled word and replaces it with the properly spelled word. document.replace("Cyles", "Cycles", true, true); -//Saves and closes the document +//Saves and closes the document. document.save("Sample.docx"); document.close(); {% endhighlight %} @@ -125,18 +125,18 @@ document.close(); You can find placeholder text in a Word document and replace it with any desired image. -The following code example illustrates how to find and replace text in a word document with an image +The following code example illustrates how to find and replace text in a Word document with an image. {% tabs %} {% highlight JAVA %} -//Opens the input Word document +//Opens the input Word document. WordDocument document = new WordDocument("Template.docx"); -//Finds all the image placeholder text in the Word document +//Finds all the image placeholder text in the Word document. TextSelection[] textSelections = document.findAll(Pattern.compile(MatchSupport.trimPattern("^//(.*)"))); for (int i = 0; i < textSelections.length; i++) { - // Replaces the image placeholder text with desired image + //Replaces the image placeholder text with the desired image. WParagraph paragraph = new WParagraph(document); WPicture picture = (WPicture) paragraph.appendPicture(new FileInputStream(textSelections[i].getSelectedText() + ".png")); TextSelection newSelection = new TextSelection(paragraph, 0, 1); @@ -144,7 +144,7 @@ for (int i = 0; i < textSelections.length; i++) bodyPart.getBodyItems().add(paragraph); document.replace(textSelections[i].getSelectedText(), bodyPart, true, true); } -//Saves and closes the document +//Saves and closes the document. document.save("Sample.docx"); document.close(); {% endhighlight %} @@ -328,7 +328,7 @@ private void importDataToRow(XmlReaderSupport reader, WTableRow tableRow) throws {% endtabs %} -## Find and replace text in Word document with another document +## Find and replace text in Word document with another document You can find and replace text with another Word document. @@ -384,9 +384,9 @@ document.close(); {% endtabs %} -## Find text in a Word document and format +## Find text in a Word document and format -You can find text in a Word document and format or highlight it .You can find the first occurrence of text using the `find` method. Find the next occurrences of the text using the `findNext` method. +You can find text in a Word document and format or highlight it. You can find the first occurrence of text using the `find` method. Find the next occurrences of the text using the `findNext` method. The following code example illustrates how to find all occurrences of a length of text and highlight it. diff --git a/java-file-formats/word-library/working-with-form-fields.md b/java-file-formats/word-library/working-with-form-fields.md index d6dc914..a661286 100644 --- a/java-file-formats/word-library/working-with-form-fields.md +++ b/java-file-formats/word-library/working-with-form-fields.md @@ -7,9 +7,9 @@ documentation: UG --- # Working with Form Fields -You can create template document with form fields such as Text, Checkbox and Drop-Down. You can also open an existing template document and fill the form fields with the specified data. +You can create a template document with form fields such as Text, Checkbox, and Drop-Down. You can also open an existing template document and fill the form fields with the specified data. -The following are the types of form field in the Word document +The following are the types of form fields in a Word document: * Checkbox – represented by an instance of WCheckBox * Drop-down – represented by an instance of WDropDownFormField diff --git a/java-file-formats/word-library/working-with-latex.md b/java-file-formats/word-library/working-with-latex.md index db68505..da65d4c 100644 --- a/java-file-formats/word-library/working-with-latex.md +++ b/java-file-formats/word-library/working-with-latex.md @@ -7,13 +7,13 @@ documentation: UG --- # Create Equation using LaTeX -The Java Word library allows to create mathematical equation in Word document using **LaTeX**. +The Java Word library allows you to create mathematical equations in a Word document using **LaTeX**. ## Accent -Add **accent** equation to a Word document using the LaTeX through **appendMath** API. +Add an **accent** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create accent equation using LaTeX in Word document. +The following code example illustrates how to create an accent equation using LaTeX in a Word document. {% tabs %} @@ -23,7 +23,7 @@ The following code example illustrates how to create accent equation using LaTeX WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an accent equation using LaTeX. +//Appends an accent equation using LaTeX. document.getLastParagraph().appendMath("\\dot{a}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -118,9 +118,9 @@ The following table demonstrates the LaTeX equivalent to professional format acc ## Bar -Add **bar** equation to a Word document using the LaTeX through **appendMath** API. +Add a **bar** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create bar equation using LaTeX in Word document. +The following code example illustrates how to create a bar equation using LaTeX in a Word document. {% tabs %} @@ -130,7 +130,7 @@ The following code example illustrates how to create bar equation using LaTeX in WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an bar equation using LaTeX. +//Appends a bar equation using LaTeX. document.getLastParagraph().appendMath("\\overline{a}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -165,9 +165,9 @@ The following table demonstrates the LaTeX equivalent to professional format bar ## Box -Add **box** equation to a Word document using the LaTeX through **appendMath** API. +Add a **box** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create box equation using LaTeX in Word document. +The following code example illustrates how to create a box equation using LaTeX in a Word document. {% tabs %} @@ -177,7 +177,7 @@ The following code example illustrates how to create box equation using LaTeX in WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an box equation using LaTeX. +//Appends a box equation using LaTeX. document.getLastParagraph().appendMath("\\box{a}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -207,9 +207,9 @@ The following table demonstrates the LaTeX equivalent to professional format box ## Border Box -Add **border box** equation to a Word document using the LaTeX through **appendMath** API. +Add a **border box** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create border box equation using LaTeX in Word document. +The following code example illustrates how to create a border box equation using LaTeX in a Word document. {% tabs %} @@ -220,7 +220,7 @@ The following code example illustrates how to create border box equation using L WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an border box equation using LaTeX. +//Appends a border box equation using LaTeX. document.getLastParagraph().appendMath("\\boxed{{x}^{2}+{y}^{2}={z}^{2}}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -251,9 +251,9 @@ The following table demonstrates the LaTeX equivalent to professional format bor ## Delimiter -Add **delimiter** equation to a Word document using the LaTeX through **appendMath** API. +Add a **delimiter** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create delimiter equation using LaTeX in Word document. +The following code example illustrates how to create a delimiter equation using LaTeX in a Word document. {% tabs %} @@ -263,7 +263,7 @@ The following code example illustrates how to create delimiter equation using La WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an delimiter equation using LaTeX. +//Appends a delimiter equation using LaTeX. document.getLastParagraph().appendMath("\\left(a\\right)"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -302,12 +302,12 @@ The following table demonstrates the LaTeX equivalent to professional format del - + - + @@ -342,12 +342,12 @@ The following table demonstrates the LaTeX equivalent to professional format del - + - + @@ -382,7 +382,7 @@ The following table demonstrates the LaTeX equivalent to professional format del - + @@ -392,7 +392,7 @@ The following table demonstrates the LaTeX equivalent to professional format del - + @@ -402,7 +402,7 @@ The following table demonstrates the LaTeX equivalent to professional format del - + @@ -428,9 +428,9 @@ The following table demonstrates the LaTeX equivalent to professional format del ## Equation Array -Add **equation array** to a Word document using the LaTeX through **appendMath** API. +Add an **equation array** to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create an equation array using LaTeX in Word document. +The following code example illustrates how to create an equation array using LaTeX in a Word document. {% tabs %} @@ -440,7 +440,7 @@ The following code example illustrates how to create an equation array using LaT WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an box equation using LaTeX. +//Appends an equation array using LaTeX. document.getLastParagraph().appendMath("\\eqarray{a@&b}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -451,7 +451,7 @@ document.close(); {% endtabs %} -The following table demonstrates the LaTeX equivalent to professional format equation array. +The following table demonstrates the LaTeX equivalent to the professional format equation array.
XHTML validation typesDescriptionXHTML validation typesDescription
XHTMLValidationType.NoneIt does not perform any schema validation but the given HTML content should meet the XHTML 1.0 format.It does not perform any schema validation, but the given HTML content should meet the XHTML 1.0 format.
XHTMLValidationType.Transitional Form Field

 -Text input, Checkbox and combo box

 Yes

 @@ -179,7 +179,7 @@ Different per section

 Partial

 -Only odd header of the first section is preserved in HTML export.
diff --git a/java-file-formats/word-library/jars-required.md b/java-file-formats/word-library/jars-required.md index 1569f36..b4a44b5 100644 --- a/java-file-formats/word-library/jars-required.md +++ b/java-file-formats/word-library/jars-required.md @@ -1,6 +1,6 @@ --- title: Jars Required for Java Word library (DocIO) | Syncfusion -description: This section illustrates external jars required to use Syncfusion Java Word library (DocIO) in Java application +description: This section illustrates the external jars required to use the Syncfusion Java Word library (DocIO) in a Java application platform: java-file-formats control: Word library documentation: UG @@ -14,10 +14,10 @@ The following jar files are required to be referenced in your Java application. 2. syncfusion-javahelper -Get the dependent jar files by installing [file formats controls](https://www.syncfusion.com/sales/products/fileformats?utm_source=ug&utm_medium=listing&utm_campaign=java-word-library#). You can find the required jars in the build installed drive. +Get the dependent jar files by installing the [file format controls](https://www.syncfusion.com/sales/products/fileformats?utm_source=ug&utm_medium=listing&utm_campaign=java-word-library#). You can find the required jars in the build installed drive. -**Location:** {ProgramFilesFolder}\Syncfusion\Essential Studio\ {Platform}\ {version}\JarFiles -**Example:** C:\Program Files (x86)\Syncfusion\Essential Studio\FileFormats\18.3.0.35\JarFiles +**Location:** {ProgramFilesFolder}\Syncfusion\Essential Studio\{Platform}\{Version}\JarFiles +**Example:** C:\Program Files (x86)\Syncfusion\Essential Studio\FileFormats\18.3.0.35\JarFiles ## Supported Java versions @@ -26,9 +26,9 @@ Syncfusion® Java Word library supports Java ## Download Jars -You can download the jars from the Syncfusion® [maven repository](https://jars.syncfusion.com/) to use our artifacts in your projects. It helps you 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 to develop with Syncfusion® controls. -**Frequently Asked questions** +**Frequently Asked Questions** * [How to configure Syncfusion® Java packages in Gradle?](https://help.syncfusion.com/document-processing/word/word-library/java/installation/configure-to-download-syncfusion-java-packages-from-gradle) * [How to configure Syncfusion® Java packages in Apache Maven?](https://help.syncfusion.com/document-processing/word/word-library/java/installation/configure-to-download-syncfusion-java-packages-from-apache-maven) diff --git a/java-file-formats/word-library/loading-and-saving-document.md b/java-file-formats/word-library/loading-and-saving-document.md index 76f0942..05dc9c9 100644 --- a/java-file-formats/word-library/loading-and-saving-document.md +++ b/java-file-formats/word-library/loading-and-saving-document.md @@ -57,16 +57,16 @@ document.open(fileStreamPath, FormatType.Automatic); {% endtabs %} -## Opening the read only Word document +## Opening the read-only Word document -You can open the ready only documents or read-only streams using the openReadOnly method. If the Word document for reading is opened by any other application such as Microsoft Word, then the same document can be opened using the DocIO in ReadOnly mode. The following code sample explains the same. +You can open read-only documents or read-only streams using the `openReadOnly` method. If the Word document you want to read is opened by another application such as Microsoft Word, you can still open the same document using DocIO in read-only mode. The following code sample explains the same. {% tabs %} {% highlight JAVA %} //Create an empty WordDocument instance. WordDocument document = new WordDocument(); -//Load or open an existing word document using the read only stream. +//Load or open an existing word document using the read-only stream. document.openReadOnly("Template.docx", FormatType.Docx); {% endhighlight %} @@ -81,7 +81,7 @@ You can save the created or manipulated Word document to the file system using t {% highlight JAVA %} //Create an empty WordDocument instance. WordDocument document = new WordDocument(); -//open an existing Word document using the Open method of WordDocument class. +//Open an existing Word document using the open method of WordDocument class. document.open(fileName); //To-Do some manipulation //To-Do some manipulation @@ -100,8 +100,8 @@ You can also save the created or manipulated word document to the stream by usin {% highlight JAVA %} //Creates an empty WordDocument instance WordDocument document = new WordDocument(); -//Opens an existing Word document through Open method of WordDocument class. -document.Open(fileName); +//Opens an existing Word document through the open method of WordDocument class. +document.open(fileName); //To-Do some manipulation //To-Do some manipulation //Create an instance of the output stream. @@ -112,26 +112,27 @@ document.save(stream, FormatType.Docx); {% endtabs %} -## Sending to a client browser +## Sending a document to a client browser -You can save and send the document to a client browser from a web site or web application by invoking the following shown overload of `save` method. This method explicitly makes use of an instance of [HttpResponse](https://msdn.microsoft.com/en-us/library/system.web.httpresponse(v=vs.110).aspx#) as its parameter to stream the document to the client browser. So, this overload is suitable for a web application that references System.Web assembly. +You can save and send the document to a client browser from a web site or web application by saving the document to a stream and writing the stream bytes to the servlet response. Set the appropriate response headers (such as `Content-Type` and `Content-Disposition`) so the browser downloads the document as an attachment. The following code sample shows how to do this from a Java servlet. {% tabs %} {% highlight JAVA %} //Create an empty WordDocument instance. WordDocument document = new WordDocument(); -//Open an existing Word document using the Open method of WordDocument class. -document.Open(fileName); +//Open an existing Word document using the open method of WordDocument class. +document.open(fileName); //To-Do some manipulation. //To-Do some manipulation. -//Create an instance of the output stream. -ByteArrayOutputStream stream = new ByteArrayOutputStream(); -//Save the document to the stream. -document.save(outputFileName, FormatType.Docx, Response, HttpContentDisposition.Attachment); +//Set the response headers so the browser downloads the document as an attachment. +response.setContentType("application/vnd.openxmlformats-officedocument.wordprocessingml.document"); +response.setHeader("Content-Disposition", "attachment; filename=\"" + outputFileName + "\""); +//Save the document to the servlet response output stream. +document.save(response.getOutputStream(), FormatType.Docx); {% endhighlight %} -{% endtabs %} +{% endtabs %} ## Closing a document @@ -142,8 +143,8 @@ Once the document manipulation and save operation are completed, you should clos {% highlight JAVA %} //Create an empty WordDocument instance. WordDocument document = new WordDocument(); -//Opens an existing Word document using the Open method of WordDocument class -document.Open(fileName); +//Opens an existing Word document using the open method of WordDocument class. +document.open(fileName); //To-Do some manipulation. //To-Do some manipulation. //Create an instance of the output stream. diff --git a/java-file-formats/word-library/mail-merge/mail-merge-events.md b/java-file-formats/word-library/mail-merge/mail-merge-events.md index e61d98b..85c86ed 100644 --- a/java-file-formats/word-library/mail-merge/mail-merge-events.md +++ b/java-file-formats/word-library/mail-merge/mail-merge-events.md @@ -8,13 +8,13 @@ documentation: UG # Event support for Mail merge -The `MailMerge` class provides event support to customize the document contents and merging image data during the Mail merge process. The following events are supported by Essential® DocIO during Mail merge process: +The `MailMerge` class provides event support to customize the document contents and merging image data during the Mail merge process. The following events are supported by Syncfusion® Word Library (DocIO) during the Mail merge process: -* `MergeField`- occurs when a **Mail merge field** except image Mail merge field is encountered. +* `MergeField` - occurs when a **Mail merge field** except image Mail merge field is encountered. -* `MergeImageField`- occurs when an **image Mail merge field** is encountered. +* `MergeImageField` - occurs when an **image Mail merge field** is encountered. -* `BeforeClearGroupField`- occurs when an **unmerged group field** is encountered. +* `BeforeClearGroupField` - occurs when an **unmerged group field** is encountered. ## MergeField Event @@ -81,7 +81,7 @@ private void applyAlternateRecordsTextColor (Object sender, MergeFieldEventArgs {% endtabs %} -The following code example shows getDataTable method which are is to get data for mail merge. +The following code example shows the getDataTable method, which is used to get data for mail merge. {% tabs %} @@ -138,7 +138,7 @@ public void add(MergeImageFieldEventHandler delegate) throws Exception public void remove(MergeImageFieldEventHandler delegate) throws Exception { if (delegate != null) - elegateList.remove(delegate); + delegateList.remove(delegate); } }); //Specifies the field names and field values. diff --git a/java-file-formats/word-library/mail-merge/mail-merge-for-group.md b/java-file-formats/word-library/mail-merge/mail-merge-for-group.md index ee9b2cd..7101501 100644 --- a/java-file-formats/word-library/mail-merge/mail-merge-for-group.md +++ b/java-file-formats/word-library/mail-merge/mail-merge-for-group.md @@ -8,7 +8,7 @@ documentation: UG # Mail merge for a group -You can perform Mail merge and append multiple records from data source within a specified region to a template document. The region between start and end groups merge fields. It gets repeated for every record from the data source. +You can perform Mail merge and append multiple records from a data source within a specified region to a template document. The region between start and end group merge fields gets repeated for every record from the data source. ## Create template for group mail merge @@ -35,7 +35,7 @@ You can perform Mail merge with Java objects in a template document. The followi {% highlight JAVA %} //Loads an existing Word document into DocIO instance. -WordDocument document = new WordDocument("EmployeesReportDemo.docx"); +WordDocument document = new WordDocument("EmployeesReportDemo.docx", FormatType.Docx); //Gets the employee details as IEnumerable collection. ListSupport employeeList = getEmployees(); //Uses the mail merge events handler for image fields. @@ -70,7 +70,7 @@ MailMergeDataTable dataSource = new MailMergeDataTable("Employees",employeeList) //Executes the mail merge for group. document.getMailMerge().executeGroup(dataSource); //Saves and closes the WordDocument instance. -document.save("Sample.docx"); +document.save("Sample.docx", FormatType.Docx); document.close(); {% endhighlight %} diff --git a/java-file-formats/word-library/mail-merge/mail-merge-for-nested-groups.md b/java-file-formats/word-library/mail-merge/mail-merge-for-nested-groups.md index d3b7901..b56869a 100644 --- a/java-file-formats/word-library/mail-merge/mail-merge-for-nested-groups.md +++ b/java-file-formats/word-library/mail-merge/mail-merge-for-nested-groups.md @@ -8,7 +8,7 @@ documentation: UG # Nested Mail merge for group -You can perform nested Mail merge with relational or hierarchical data source and independent data tables in a template document. +You can perform nested Mail merge with relational or hierarchical data source and independent data tables in a template document. ## Mail merge with implicit relational data @@ -22,7 +22,7 @@ For example: * The merge field name should be like “TableName:Id” (<>) * The merge field name should be like “Image:TableName:Photo” (<>) -For example, consider that you have a template document as follow. +For example, consider that you have a template document as follows. ![Word document template to map the fields of ancestor group](../MailMerge_images/Mail_merge_with_implicit_relation_template.png) diff --git a/java-file-formats/word-library/mail-merge/mail-merge-options.md b/java-file-formats/word-library/mail-merge/mail-merge-options.md index 473dc44..a3886af 100644 --- a/java-file-formats/word-library/mail-merge/mail-merge-options.md +++ b/java-file-formats/word-library/mail-merge/mail-merge-options.md @@ -12,9 +12,9 @@ The `MailMerge` class allows you to customize the Mail merge process with the fo ## Field Mapping -The `MailMerge` class can automatically **maps the merge field names with data source column names** during Mail merge process. You can also customize the field mapping when the merge field names in the template document varies with the column names in the data source by using `MappedFields` collection. +The `MailMerge` class can automatically **map the merge field names** with data source column names during the Mail merge process. You can also customize the field mapping when the merge field names in the template document vary with the column names in the data source by using the `MappedFields` collection. -The following code example shows how to add mapping when a merge field name in a document and column name in data source have different names. +The following code example shows how to add mapping when a merge field name in a document and column name in the data source have different names. {% tabs %} @@ -106,7 +106,7 @@ The following code example shows how to keep the unmerged merge fields in the ge {% highlight JAVA %} //Opens the template document. WordDocument document = new WordDocument("Template.docx", FormatType.Docx); -//Sets “ClearFields” to true to remove empty mail merge fields from document. +//Sets “ClearFields” to false to keep empty mail merge fields from document. document.getMailMerge().setClearFields(false); //Specifies the field names and field values. String[] fieldNames = new String[] { "EmployeeId", "Phone", "City" }; @@ -154,7 +154,7 @@ The following code example shows getEmployees method which is used to get data f {% highlight JAVA %} public ListSupport getEmployees() throws Exception { - /Gets the OrderDetails as “IEnumerable” collection. + //Gets the OrderDetails as “IEnumerable” collection. ListSupport orders = new ListSupport(); orders.add(new OrderDetails("10835", LocalDateTime.of(2015, 1, 5,0,0,0), LocalDateTime.of(2015, 1, 12,0,0,0), LocalDateTime.of(2015, 1, 21,0,0,0))); //Gets the CustomerDetails as “IEnumerable” collection. @@ -332,7 +332,7 @@ public class OrderDetails { return _orderDate; } - ublic LocalDateTime setOrderDate(LocalDateTime value)throws Exception + public LocalDateTime setOrderDate(LocalDateTime value)throws Exception { _orderDate=value; return value; diff --git a/java-file-formats/word-library/mail-merge/simple-mail-merge.md b/java-file-formats/word-library/mail-merge/simple-mail-merge.md index b6acf85..f9888a2 100644 --- a/java-file-formats/word-library/mail-merge/simple-mail-merge.md +++ b/java-file-formats/word-library/mail-merge/simple-mail-merge.md @@ -12,7 +12,7 @@ You can create a Word document template using Microsoft Word application or by a ## Mail merge with string arrays -The `MailMerge` class provides various overloads for `execute` method to perform Mail merge from various data sources. The Mail merge operation replaces the matching merge fields with the respective data. +The `MailMerge` class provides various overloads for the `execute` method to perform Mail merge from various data sources. The Mail merge operation replaces the matching merge fields with the respective data. ### Create Word document template The following code example shows how to create a Word template document with merge fields. diff --git a/java-file-formats/word-library/overview.md b/java-file-formats/word-library/overview.md index 0546d22..dedf16d 100644 --- a/java-file-formats/word-library/overview.md +++ b/java-file-formats/word-library/overview.md @@ -7,20 +7,20 @@ documentation: UG --- # Overview of Word library (DocIO) -Essential® DocIO is a native Java Word library that is used by developers to create, read, write, and convert the Microsoft Word documents in the Java application without Microsoft Word or interop dependencies. +Essential® DocIO is a native Java Word library used to create, read, write, and convert Microsoft Word documents in Java applications without Microsoft Word or interop dependencies. -It is a non-UI component that provides a full-fledged document instance model similar to the Microsoft Office COM libraries to iterate with the document elements explicitly and perform necessary manipulation. It is built from scratch in Java and does not require Microsoft Word to be installed in the machine. It supports Word 2007 and later versions documents. +It is a non-UI component that provides a full-fledged document instance model similar to the Microsoft Office COM libraries, letting you interact with document elements explicitly and perform the necessary manipulations. It is built from scratch in Java and does not require Microsoft Word to be installed on the machine. It supports Word 2007 and later versions of Word documents. **Key Features** -* Support to [create Word document](https://help.syncfusion.com/document-processing/word/word-library/java/getting-started) from scratch. -* Support to open, modify, and save the existing Word documents. +* Support to [create Word documents](https://help.syncfusion.com/document-processing/word/word-library/java/getting-started) from scratch. +* Support to open, modify, and save existing Word documents. * Advanced [Mail merge](https://help.syncfusion.com/document-processing/word/word-library/java/working-with-mail-merge) support with different data sources. -* Ability to create or edit Word 2007 and later version documents, and convert them to commonly used file formats such as [WordML](https://help.syncfusion.com/document-processing/word/word-library/java/word-file-formats#word-processing-xml-xml), [TXT](https://help.syncfusion.com/document-processing/word/word-library/java/text), [HTML](https://help.syncfusion.com/document-processing/word/word-library/java/html) and vice versa. -* Ability to create and manipulate [shapes](https://help.syncfusion.com/document-processing/word/word-library/java/working-with-shapes), and [group shape](https://help.syncfusion.com/document-processing/word/word-library/java/working-with-shapes#grouping-shapes) in the DOCX and WordML format documents. -* Ability to read and write the [built-in and custom document properties](https://help.syncfusion.com/document-processing/word/word-library/java/working-with-word-document#working-with-word-document-properties). -* Support to insert and edit the [form fields](https://help.syncfusion.com/document-processing/word/word-library/java/working-with-form-fields). -* Ability to insert the [bookmarks](https://help.syncfusion.com/document-processing/word/word-library/java/working-with-bookmarks) and navigate corresponding bookmarks to insert, replace, and delete content. +* Ability to create or edit Word 2007 and later documents and convert them to commonly used file formats such as [WordML](https://help.syncfusion.com/document-processing/word/word-library/java/word-file-formats#word-processing-xml-xml), [TXT](https://help.syncfusion.com/document-processing/word/word-library/java/text), and [HTML](https://help.syncfusion.com/document-processing/word/word-library/java/html), and vice versa. +* Ability to create and manipulate [shapes](https://help.syncfusion.com/document-processing/word/word-library/java/working-with-shapes) and [group shapes](https://help.syncfusion.com/document-processing/word/word-library/java/working-with-shapes#grouping-shapes) in DOCX and WordML format documents. +* Ability to read and write [built-in and custom document properties](https://help.syncfusion.com/document-processing/word/word-library/java/working-with-word-document#working-with-word-document-properties). +* Support to insert and edit [form fields](https://help.syncfusion.com/document-processing/word/word-library/java/working-with-form-fields). +* Ability to insert [bookmarks](https://help.syncfusion.com/document-processing/word/word-library/java/working-with-bookmarks) and navigate to them to insert, replace, and delete content. **Compatible Microsoft Word Versions** @@ -29,11 +29,15 @@ It is a non-UI component that provides a full-fledged document instance model si * Microsoft Word 2013 * Microsoft Word 2016 * Microsoft Word 2019 +* Microsoft Word 2021 +* Microsoft 365 -T> Sometimes a Java application may throw an error like this "Java.Lang.OutOfMemoryError." Usually, this error occurs due to insufficient RAM heap space to allocate an object in the Java heap. To avoid this kind of problem, we suggest [increasing the JVM heap size](https://docs.oracle.com/cd/E29587_01/PlatformServices.60x/ps_rel_discovery/src/crd_advanced_jvm_heap.html). +T> Sometimes a Java application may throw an error like `java.lang.OutOfMemoryError`. Usually, this error occurs due to insufficient RAM heap space to allocate an object in the Java heap. To avoid this kind of problem, we suggest [increasing the JVM heap size](https://docs.oracle.com/cd/E29587_01/PlatformServices.60x/ps_rel_discovery/src/crd_advanced_jvm_heap.html). -N> Currently, Essential® DocIO supports .DOCX, .DOTX, .DOTM, .DOCM, .WordML, .RTF, .Txt, WordML, HTML. Please refer to the [supported and unsupported features](https://help.syncfusion.com/document-processing/word/word-library/java/supported-and-unsupported-features) in the essential® DocIO. +N> Currently, Essential® DocIO supports .docx, .dotx, .dotm, .docm, WordML, .rtf, .txt, and HTML. Please refer to the [supported and unsupported features](https://help.syncfusion.com/document-processing/word/word-library/java/supported-and-unsupported-features) in Essential® DocIO. **See Also** * [Jars Required for Java Word library (DocIO)](https://help.syncfusion.com/document-processing/word/word-library/java/jars-required#download-jars) +* [Getting Started with Java Word library (DocIO)](https://help.syncfusion.com/document-processing/word/word-library/java/getting-started) +* [Installation and Configuration](https://help.syncfusion.com/document-processing/word/word-library/java/installation/available-syncfusion-java-packages) diff --git a/java-file-formats/word-library/rtf.md b/java-file-formats/word-library/rtf.md index 24bcf8d..c791098 100644 --- a/java-file-formats/word-library/rtf.md +++ b/java-file-formats/word-library/rtf.md @@ -40,4 +40,4 @@ document.close(); {% endtabs %} ## Supported and Unsupported features -The supported and unsupported features of DocIO based on file formats can be referred [here](https://help.syncfusion.com/document-processing/word/word-library/java/supported-and-unsupported-features#) \ No newline at end of file +The supported and unsupported features of DocIO based on file formats can be referred [here](https://help.syncfusion.com/document-processing/word/word-library/java/supported-and-unsupported-features) \ No newline at end of file diff --git a/java-file-formats/word-library/supported-and-unsupported-features.md b/java-file-formats/word-library/supported-and-unsupported-features.md index b8484b1..626e4cf 100644 --- a/java-file-formats/word-library/supported-and-unsupported-features.md +++ b/java-file-formats/word-library/supported-and-unsupported-features.md @@ -278,8 +278,8 @@ No

Equation

 -No

 -No

 +Yes

 +Yes

 No

 No

4. Delimiter equation\left\lfloora\right\rfloor\left\lfloor a\right\rfloor
5. Delimiter equation\left\lceila\right\rceil\left\lceil a\right\rceil
6.
12. Delimiter equation\left\langlea\middle|b\right\rangle\left\langle a\middle|b\right\rangle
13. Delimiter equation\left\langlea\middle|b\middle|c\right\rangle\left\langle a\middle|b\middle|c\right\rangle
14.
20. Delimiter equation\left\langlea\right.\left\langle a\right.
21.
22. Delimiter equation\left\lfloora\right.\left\lfloor a\right.
23.
24. Delimiter equation\left\lceila\right.\left\lceil a\right.
25.
@@ -470,9 +470,9 @@ The following table demonstrates the LaTeX equivalent to professional format equ ## Fraction -Add **fraction** equation to a Word document using the LaTeX through **appendMath** API. +Add a **fraction** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create fraction equation using LaTeX in Word document. +The following code example illustrates how to create a fraction equation using LaTeX in a Word document. {% tabs %} @@ -482,7 +482,7 @@ The following code example illustrates how to create fraction equation using LaT WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an fraction equation using LaTeX. +//Appends a fraction equation using LaTeX. document.getLastParagraph().appendMath("{\\frac{dy}{dx}}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -493,7 +493,7 @@ document.close(); {% endtabs %} -The following table demonstrates the LaTeX equivalent to professional format fraction equations. +The following table demonstrates the LaTeX equivalent to the professional format fraction equations.
@@ -506,7 +506,7 @@ The following table demonstrates the LaTeX equivalent to professional format fra - + @@ -523,9 +523,9 @@ The following table demonstrates the LaTeX equivalent to professional format fra ## Function -Add **function** equation to a Word document using the LaTeX through **appendMath** API. +Add a **function** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create function equation using LaTeX in Word document. +The following code example illustrates how to create a function equation using LaTeX in a Word document. {% tabs %} @@ -535,7 +535,7 @@ The following code example illustrates how to create function equation using LaT WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an function equation using LaTeX. +//Appends a function equation using LaTeX. document.getLastParagraph().appendMath("\\sin{\\theta}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -546,7 +546,7 @@ document.close(); {% endtabs %} -The following table demonstrates the LaTeX equivalent to professional format function equations. +The following table demonstrates the LaTeX equivalent to the professional format function equations.
1. Fraction equationfrac{\mathbit{dy}}{\mathbit{dx}}\frac{\mathbit{dy}}{\mathbit{dx}}
2.
@@ -710,9 +710,9 @@ The following table demonstrates the LaTeX equivalent to professional format fun ## Group character -Add **group character** equation to a Word document using the LaTeX through **appendMath** API. +Add a **group character** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create group character equation using LaTeX in Word document. +The following code example illustrates how to create a group character equation using LaTeX in a Word document. {% tabs %} @@ -722,7 +722,7 @@ The following code example illustrates how to create group character equation us WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an group character equation using LaTeX. +//Appends a group character equation using LaTeX. document.getLastParagraph().appendMath("\\overbrace{a-b}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -733,7 +733,7 @@ document.close(); {% endtabs %} -The following table demonstrates the LaTeX equivalent to professional format group character equations. +The following table demonstrates the LaTeX equivalent to the professional format group character equations.
@@ -757,9 +757,9 @@ The following table demonstrates the LaTeX equivalent to professional format gro ## Limit -Add **limit** equation to a Word document using the LaTeX through **appendMath** API. +Add a **limit** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create limit equation using LaTeX in Word document. +The following code example illustrates how to create a limit equation using LaTeX in a Word document. {% tabs %} @@ -769,7 +769,7 @@ The following code example illustrates how to create limit equation using LaTeX WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an limit equation using LaTeX. +//Appends a limit equation using LaTeX. document.getLastParagraph().appendMath("\\lim\\below{b}{a}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -780,7 +780,7 @@ document.close(); {% endtabs %} -The following table demonstrates the LaTeX equivalent to professional format limit equations. +The following table demonstrates the LaTeX equivalent to the professional format limit equations.
@@ -809,9 +809,9 @@ The following table demonstrates the LaTeX equivalent to professional format lim ## Matrix -Add **matrix** equation to a Word document using the LaTeX through **appendMath** API. +Add a **matrix** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create matrix equation using LaTeX in Word document. +The following code example illustrates how to create a matrix equation using LaTeX in a Word document. {% tabs %} @@ -821,7 +821,7 @@ The following code example illustrates how to create matrix equation using LaTeX WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an matrix equation using LaTeX. +//Appends a matrix equation using LaTeX. document.getLastParagraph().appendMath("\\begin{matrix}a&b\\\\\\end{matrix}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -832,7 +832,7 @@ document.close(); {% endtabs %} -The following table demonstrates the LaTeX equivalent to professional format matrix equations. +The following table demonstrates the LaTeX equivalent to the professional format matrix equations.
@@ -851,9 +851,9 @@ The following table demonstrates the LaTeX equivalent to professional format mat ## N-array -Add **N-array** equation to a Word document using the LaTeX through **appendMath** API. +Add an **N-array** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create N-array equation using LaTeX in Word document. +The following code example illustrates how to create an N-array equation using LaTeX in a Word document. {% tabs %} @@ -863,7 +863,7 @@ The following code example illustrates how to create N-array equation using LaTe WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an N-array equation using LaTeX. +//Appends an N-array equation using LaTeX. document.getLastParagraph().appendMath("\\sum{a}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -874,7 +874,7 @@ document.close(); {% endtabs %} -The following table demonstrates the LaTeX equivalent to professional format N-array equations. +The following table demonstrates the LaTeX equivalent to the professional format N-array equations.
@@ -943,9 +943,9 @@ The following table demonstrates the LaTeX equivalent to professional format N-a ## Radical -Add **radical** equation to a Word document using the LaTeX through **appendMath** API. +Add a **radical** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create radical equation using LaTeX in Word document. +The following code example illustrates how to create a radical equation using LaTeX in a Word document. {% tabs %} @@ -955,7 +955,7 @@ The following code example illustrates how to create radical equation using LaTe WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an radical equation using LaTeX. +//Appends a radical equation using LaTeX. document.getLastParagraph().appendMath("\\sqrt{a}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -966,7 +966,7 @@ document.close(); {% endtabs %} -The following table demonstrates the LaTeX equivalent to professional format radical equations. +The following table demonstrates the LaTeX equivalent to the professional format radical equations.
@@ -990,9 +990,9 @@ The following table demonstrates the LaTeX equivalent to professional format rad ## SubSuperScript -Add **SubSuperScript** equation to a Word document using the LaTeX through **appendMath** API. +Add a **SubSuperScript** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create SubSuperScript equation using LaTeX in Word document. +The following code example illustrates how to create a SubSuperScript equation using LaTeX in a Word document. {% tabs %} @@ -1002,7 +1002,7 @@ The following code example illustrates how to create SubSuperScript equation usi WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an SubSuperScript equation using LaTeX. +//Appends a SubSuperScript equation using LaTeX. document.getLastParagraph().appendMath("{a}^{b}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -1013,7 +1013,7 @@ document.close(); {% endtabs %} -The following table demonstrates the LaTeX equivalent to professional format SubSuperScript equations. +The following table demonstrates the LaTeX equivalent to the professional format SubSuperScript equations.
@@ -1037,9 +1037,9 @@ The following table demonstrates the LaTeX equivalent to professional format Sub ## Left SubSuperScript -Add **Left SubSuperScript** equation to a Word document using the LaTeX through **appendMath** API. +Add a **Left SubSuperScript** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create Left SubSuperScript equation using LaTeX in Word document. +The following code example illustrates how to create a Left SubSuperScript equation using LaTeX in a Word document. {% tabs %} @@ -1049,7 +1049,7 @@ The following code example illustrates how to create Left SubSuperScript equatio WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an Left SubSuperScript equation using LaTeX. +//Appends a Left SubSuperScript equation using LaTeX. document.getLastParagraph().appendMath("{_{40}^{20}}{100}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -1060,7 +1060,7 @@ document.close(); {% endtabs %} -The following table demonstrates the LaTeX equivalent to professional format Left SubSuperScript equations. +The following table demonstrates the LaTeX equivalent to the professional format Left SubSuperScript equations.
@@ -1079,9 +1079,9 @@ The following table demonstrates the LaTeX equivalent to professional format Lef ## Right SubSuperScript -Add **Right SubSuperScript** equation to a Word document using the LaTeX through **appendMath** API. +Add a **Right SubSuperScript** equation to a Word document using LaTeX through the **appendMath** API. -The following code example illustrates how to create Right SubSuperScript equation using LaTeX in Word document. +The following code example illustrates how to create a Right SubSuperScript equation using LaTeX in a Word document. {% tabs %} @@ -1091,7 +1091,7 @@ The following code example illustrates how to create Right SubSuperScript equati WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an Right SubSuperScript equation using LaTeX. +//Appends a Right SubSuperScript equation using LaTeX. document.getLastParagraph().appendMath("{100}_{40}^{20}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -1102,7 +1102,7 @@ document.close(); {% endtabs %} -The following table demonstrates the LaTeX equivalent to professional format Right SubSuperScript equations. +The following table demonstrates the LaTeX equivalent to the professional format Right SubSuperScript equations.
@@ -1156,9 +1156,9 @@ The following code example demonstrates how to apply styles to characters within WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an accent equation with bold using LaTeX. +//Appends an accent equation with bold using LaTeX. document.getLastParagraph().appendMath("\\dot{\\mathbf{a}}"); -//Append an accent equation with bold-italic using LaTeX. +//Appends an accent equation with bold-italic using LaTeX. document.getLastSection().addParagraph().appendMath("\\dot{\\mathbit{a}}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -1216,15 +1216,15 @@ The following code examples show how to apply the scripts to equations in a Word WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an accent equation with Double-Struck font using LaTeX. +//Appends an accent equation with Double-Struck font using LaTeX. document.getLastParagraph().appendMath("\\dot{\\mathbb{a}}"); -//Append an accent equation with Fraktur font using LaTeX. +//Appends an accent equation with Fraktur font using LaTeX. document.getLastSection().addParagraph().appendMath("\\dot{\\mathfrak{a}}"); -//Append an accent equation with Sans Serif font using LaTeX. +//Appends an accent equation with Sans Serif font using LaTeX. document.getLastSection().addParagraph().appendMath("\\dot{\\mathsf{a}}"); -//Append an accent equation with Script using LaTeX. +//Appends an accent equation with Script using LaTeX. document.getLastSection().addParagraph().appendMath("\\dot{\\mathcal{a}}"); -//Append an accent equation with Script using LaTeX. +//Appends an accent equation with Script using LaTeX. document.getLastSection().addParagraph().appendMath("\\dot{\\mathscr{a}}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -1251,7 +1251,7 @@ The following code example shows how to preserve text as normal text, without an WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an accent equation as normal text using LaTeX. +//Appends an accent equation as normal text using LaTeX. document.getLastParagraph().appendMath("\\dot{\\mathrm{a}}"); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -1264,9 +1264,9 @@ document.close(); ## Apply Math Justification -Apply justification, such as Left, Right, and more to the equation in a Word document using the Java Word library. +Apply justification, such as Left, Right, and more, to the equation in a Word document using the Java Word library. -The following code examples show how to apply the justification to equations in a Word document. +The following code example shows how to apply the justification to equations in a Word document. {% tabs %} @@ -1277,9 +1277,9 @@ The following code examples show how to apply the justification to equations in WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document. document.ensureMinimal(); -//Append an border box equation using LaTeX. +//Appends a border box equation using LaTeX. WMath math = document.getLastParagraph().appendMath("\\boxed{{x}^{2}+{y}^{2}={z}^{2}}"); -//Apply math justification. +//Applies math justification. math.getMathParagraph().setJustification(MathJustification.Left); //Saves the Word document. document.save("Sample.docx", FormatType.Docx); @@ -1295,26 +1295,26 @@ document.close(); You can modify the text of an equation by replacing the string value in the LaTeX API, which retrieves the LaTeX string representation of the professional equation in the Word document. -The following code snippet shows how to modify the LaTeX equation in a Word document. +The following code snippet shows how to modify a LaTeX equation in a Word document. {% tabs %} {% highlight JAVA %} -//Creates a new Word document. +//Opens an existing Word document. WordDocument document = new WordDocument("Template.docx", FormatType.Automatic); //Adds one section and one paragraph to the document. document.ensureMinimal(); - -// Access the first paragraph from the last section of the document. + +//Accesses the first paragraph from the last section of the document. WParagraph paragraph = (WParagraph)document.getLastSection().getBody().getChildEntities().get(0); -// Retrieve the first math equation in the paragraph, if it exists. +//Retrieves the first math equation in the paragraph, if it exists. WMath math = (WMath) paragraph.getChildEntities().get(0); if (math != null) { - // Get the LaTeX representation of the math equation. + //Gets the LaTeX representation of the math equation. String laTeX = math.getMathParagraph().getLaTeX(); - // Replace occurrences of 'x' with 'k' in the LaTeX representation. + //Replaces occurrences of 'x' with 'k' in the LaTeX representation. math.getMathParagraph().setLaTeX(laTeX.replace("x", "k")); } diff --git a/java-file-formats/word-library/working-with-lists.md b/java-file-formats/word-library/working-with-lists.md index b6112da..30f9420 100644 --- a/java-file-formats/word-library/working-with-lists.md +++ b/java-file-formats/word-library/working-with-lists.md @@ -6,12 +6,12 @@ control: Word Library documentation: UG --- -# Working with lists +# Working with Lists -Lists can organize and format the contents of a document in hierarchical way. There are nine levels in the list, starting from level 0 to level 8. DocIO supports both built-in list styles and custom list styles. The following are the types of list supported in DocIO: +Lists can organize and format the contents of a document in a hierarchical way. There are nine levels in the list, starting from level 0 to level 8. DocIO supports both built-in list styles and custom list styles. The following are the types of lists supported in DocIO: * Numbered list -* Bulleted list +* Bulleted list ## Create Bulleted List @@ -26,7 +26,7 @@ WordDocument document = new WordDocument(); IWSection section = document.addSection(); //Add a new paragraph to the section. IWParagraph paragraph = section.addParagraph(); -//Apply the default numbered list style. +//Apply the default bulleted list style. paragraph.getListFormat().applyDefBulletStyle(); //Add text to the paragraph. paragraph.appendText("List item 1"); @@ -301,12 +301,12 @@ paragraph = section.addParagraph(); paragraph.appendText("Multilevel numbered list - Level 0"); //Continue the last defined list. paragraph.getListFormat().continueListNumbering(); -//Increase the level indent. +//Decrease the level indent. paragraph.getListFormat().decreaseIndentLevel(); //Add a new paragraph. paragraph = section.addParagraph(); paragraph.appendText("Multilevel numbered list - Level 1"); -//Continue he last defined list. +//Continue the last defined list. paragraph.getListFormat().continueListNumbering(); //Increase the level indent. paragraph.getListFormat().increaseIndentLevel(); @@ -371,7 +371,7 @@ document.close(); The following code example explains how to create numbered list with prefix from previous level. -N> The `NumberPrefix` value for the numbered list should meet the syntax “\u000N” to update the previous list level value as a prefix to the current list level. For example, it should be represented as (“\u0000.” or “\u0000.\u0001.”). +N> The `NumberPrefix` value for the numbered list should meet the syntax “\u000N” to update the previous list level value as a prefix to the current list level. For example, it should be represented as ("\u0000." or "\u0000.\u0001."). {% tabs %} {% highlight JAVA %} @@ -428,11 +428,11 @@ document.close(); ## Get list value -You can get the string that represents the appearance of **list value of the paragraph** in the Word document using the `ListString` API. +You can get the string that represents the appearance of **the list value of the paragraph** in the Word document using the `ListString` API. -This API holds the static string of the list value recently calculated while saving the document as Text. It is not updated automatically for each modification done in the Word document. Hence, you should either invoke the `getText()` method of `WordDocument` or save the Word document as Text to get the actual list value from this API. +This API holds the static string of the list value recently calculated while saving the document as text. It is not updated automatically for each modification done in the Word document. Hence, you should either invoke the `getText()` method of `WordDocument` or save the Word document as text to get the actual list value from this API. -The following example shows how to **get a string that represents the appearance of list value of the paragraph**. +The following example shows how to **get a string that represents the appearance of the list value of the paragraph**. {% tabs %} @@ -441,7 +441,7 @@ The following example shows how to **get a string that represents the appearance WordDocument document = new WordDocument("Template.docx"); //Get the document text. document.getText(); -//Get the string that represents the appearance of list value of the paragraph. +//Get the string that represents the appearance of the list value of the paragraph. String listString = document.getLastParagraph().getListString(); //Save and close the WordDocument instance. document.save("Sample.docx", FormatType.Docx); diff --git a/java-file-formats/word-library/working-with-mail-merge.md b/java-file-formats/word-library/working-with-mail-merge.md index 28216fa..da59700 100644 --- a/java-file-formats/word-library/working-with-mail-merge.md +++ b/java-file-formats/word-library/working-with-mail-merge.md @@ -11,8 +11,8 @@ Mail merge is a process of merging data from data source to a Word template docu The following data sources are supported by Essential® DocIO for performing Mail merge: -* String Arrays -* Java objects +* String arrays +* Java objects (business objects) ## Mail merge process @@ -25,7 +25,7 @@ The mail merge process involves three documents: 3. **Final merged document**: This resultant document is a combination of the template Word document and the data from data source. T> 1. You can use conditional fields ([IF](https://support.microsoft.com/en-us/office/field-codes-if-field-9f79e82f-e53b-4ff5-9d2c-ae3b22b7eb5e?ui=en-us&rs=en-us&ad=us), [Formula](https://support.microsoft.com/en-us/office/field-codes-formula-field-32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d?ui=en-us&rs=en-us&ad=us)) combined with merge fields, when you require intelligent decisions in addition to simple mail merge (replace merge fields with result text). To use conditional fields, execute mail merge and then update fields in the Word document using `updateDocumentFields` API. -T> 2. You can replace the fields ([IF](https://support.microsoft.com/en-us/office/field-codes-if-field-9f79e82f-e53b-4ff5-9d2c-ae3b22b7eb5e?ui=en-us&rs=en-us&ad=us), [Formula](https://support.microsoft.com/en-us/office/field-codes-formula-field-32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d?ui=en-us&rs=en-us&ad=us)) combined with merge fields, with its most recent result and **generates the plain Word document** by unlinking the fields. Refer to this [link](https://help.syncfusion.com/document-processing/word/word-library/java/working-with-fields#unlink-fields) for more information. +T> 2. You can replace the fields ([IF](https://support.microsoft.com/en-us/office/field-codes-if-field-9f79e82f-e53b-4ff5-9d2c-ae3b22b7eb5e?ui=en-us&rs=en-us&ad=us), [Formula](https://support.microsoft.com/en-us/office/field-codes-formula-field-32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d?ui=en-us&rs=en-us&ad=us)) combined with merge fields, with its most recent result and **generate the plain Word document** by unlinking the fields. Refer to this [link](https://help.syncfusion.com/document-processing/word/word-library/java/working-with-fields#unlink-fields) for more information. ### Create Word document template diff --git a/java-file-formats/word-library/working-with-mathematical-equation.md b/java-file-formats/word-library/working-with-mathematical-equation.md index bd55151..bab994a 100644 --- a/java-file-formats/word-library/working-with-mathematical-equation.md +++ b/java-file-formats/word-library/working-with-mathematical-equation.md @@ -1,15 +1,15 @@ --- title: Working with Mathematical Equation | Syncfusion -description: This section illustrates about create, modify and remove mathematical equation in Word document without MS Word or Office interop +description: This section illustrates how to create, modify, and remove mathematical equations in a Word document without MS Word or Office interop platform: java-file-formats control: Word Library documentation: UG --- # Working with Mathematical Equation -Equations in Word document are combination of mathematical symbols or text. For example, you can create a Fourier series equation in Word document. +Equations in a Word document are a combination of mathematical symbols or text. For example, you can create a Fourier series equation in a Word document. -The Java Word library offers two ways to create and modify equations in Word document. +The Java Word library offers two ways to create and modify equations in a Word document. * [Using WMath DOM](https://help.syncfusion.com/java-file-formats/word-library/working-with-mathematical-equation#types-of-equation). * [Using LaTeX](https://help.syncfusion.com/java-file-formats/word-library/working-with-latex). @@ -18,7 +18,7 @@ The Java Word library offers two ways to create and modify equations in Word doc ## Types of equation -The following different structures of equation can be created by using the Essential® DocIO. +The following different structures of equations can be created by using the Essential® DocIO. ![Different structures of equation in Microsoft Word application](WorkingwithMathematicalEquation_images/EquationStructures.png) @@ -50,13 +50,13 @@ You can add an accent mark to the equation. The following code example shows how WordDocument document = new WordDocument(); //Adds one section and one paragraph to the document document.ensureMinimal(); -//Appends a new mathematical equation to the paragraph +//Appends a new mathematical equation to the paragraph. WMath math = document.getLastParagraph().appendMath(); -//Adds a new math +//Adds a new math. IOfficeMath officeMath = math.getMathParagraph().getMaths().add(); -//Adds an accent equation +//Adds an accent equation. IOfficeMathAccent mathAccent = (IOfficeMathAccent) officeMath.getFunctions().add(MathFunctionType.Accent); -//Sets the accent character +//Sets the accent character. mathAccent.setAccentCharacter("̆"); //Adds the run element for accent IOfficeMathRunElement officeMathRunElement = (IOfficeMathRunElement) mathAccent.getEquation().getFunctions().add(MathFunctionType.RunElement); @@ -77,13 +77,13 @@ document.close(); ### Bar -You can add a bar (which adds horizontal line on top or bottom) to the equation. The following code example shows how to add a bar to the equation. +You can add a bar (which adds a horizontal line on top or bottom) to the equation. The following code example shows how to add a bar to the equation. {% tabs %} {% highlight JAVA %} //Creates a new Word document WordDocument document = new WordDocument(); -//Add a section and a paragraph in the empty document +//Add a section and a paragraph in the empty document. document.ensureMinimal(); //Appends a new mathematical equation to the paragraph WMath math = document.getLastParagraph().appendMath(); @@ -564,8 +564,7 @@ document.close(); ### Phantom -You can create a phantom equation to add the spacing of the phantom -without displaying that base and suppressing part of the glyph from spacing considerations. The following code example shows how to create a phantom equation. +You can create a phantom equation to add the spacing of the phantom without displaying that base and suppressing part of the glyph from spacing considerations. The following code example shows how to create a phantom equation. {% tabs %} {% highlight JAVA %} //Creates a new Word document diff --git a/java-file-formats/word-library/working-with-paragraph.md b/java-file-formats/word-library/working-with-paragraph.md index e15b1ea..65414cd 100644 --- a/java-file-formats/word-library/working-with-paragraph.md +++ b/java-file-formats/word-library/working-with-paragraph.md @@ -379,7 +379,7 @@ for(Object paragraph_tempObj : textbody.getParagraphs()) { WPicture picture = (WPicture)(item); //Replace the image. - if(picture.getTitle()=="Bookmark") + if("Bookmark".equals(picture.getTitle())) { FileInputStream file = new FileInputStream("Image.png"); byte[] byarr = new byte[(int) file.getChannel().size()]; @@ -504,7 +504,7 @@ for(Object item_tempObj : textBody.getChildEntities()) { //Get the image from its title and modifies its width and height. WPicture picture = (WPicture)(paraItem); - if(picture.getTitle () == "Bookmark") + if("Bookmark".equals(picture.getTitle())) { picture.setWidth(150); picture.setHeight(100); diff --git a/java-file-formats/word-library/working-with-sections.md b/java-file-formats/word-library/working-with-sections.md index 628ba50..ff06517 100644 --- a/java-file-formats/word-library/working-with-sections.md +++ b/java-file-formats/word-library/working-with-sections.md @@ -202,7 +202,7 @@ paragraph.appendText("\r\r[ Third Page ] \r\r" + paraText); paragraph = section.getHeadersFooters().getOddHeader().addParagraph(); paragraph.appendText("[ Default Page Header ]"); //Insert the default page footer. -paragraph = section.getHeadersFooters().getOddHeader().addParagraph(); +paragraph = section.getHeadersFooters().getOddFooter().addParagraph(); paragraph.appendText("[ Default Page Footer ]"); //Save and close the Word document instance. document.save("Sample.docx", FormatType.Docx); diff --git a/java-file-formats/word-library/working-with-security.md b/java-file-formats/word-library/working-with-security.md index 844bfc0..423634e 100644 --- a/java-file-formats/word-library/working-with-security.md +++ b/java-file-formats/word-library/working-with-security.md @@ -96,7 +96,7 @@ document.close(); ## Editable ranges -An **editable range** is a portion of a Word document that allows editing even when the document is protected. In the Syncfusion .NET Word library (DocIO), editable ranges are represented using the **EditableRange** class. You can define these ranges programmatically to allow user edits within protected documents. +An **editable range** is a portion of a Word document that allows editing even when the document is protected. In the Syncfusion Java Word library (DocIO), editable ranges are represented using the **EditableRange** class. You can define these ranges programmatically to allow user edits within protected documents. ### Add an editable range diff --git a/java-file-formats/word-library/working-with-shapes.md b/java-file-formats/word-library/working-with-shapes.md index 038e080..1d1b0f6 100644 --- a/java-file-formats/word-library/working-with-shapes.md +++ b/java-file-formats/word-library/working-with-shapes.md @@ -1,6 +1,6 @@ --- title: Working with Shapes | Syncfusion -description: This section describes how to work with the shapes and groupshape in Word document using Syncfusion Java Word library (Essential DocIO) +description: This section describes how to work with the shapes and group shape in Word document using Syncfusion Java Word library (Essential DocIO) platform: java-file-formats control: Word Library documentation: UG @@ -126,7 +126,7 @@ document.close(); ## Grouping shapes -Word library now allows you to create or group multiple shapes, pictures, text boxes as a group shape in Word document (DOCX) and preserve it as in DOCX and WordML format conversions. +Word library now allows you to create a group of multiple shapes, pictures, text boxes as a group shape in Word document (DOCX) and preserve it as in DOCX and WordML format conversions. You can create a document with group shapes by using Microsoft Word. It provides an option to group a set of shapes and images as a single shape and a group shape as individual item. ![Create Group shape in Microsoft Word](Working-with-Shapes_images/Working-with-Shapes_img1.jpeg) diff --git a/java-file-formats/word-library/working-with-tables.md b/java-file-formats/word-library/working-with-tables.md index 9a3f11c..72059de 100644 --- a/java-file-formats/word-library/working-with-tables.md +++ b/java-file-formats/word-library/working-with-tables.md @@ -55,7 +55,7 @@ textRange.getCharacterFormat().setFontSize(10); textRange = table.get(1, 1).addParagraph().appendText("50"); textRange.getCharacterFormat().setFontName("Arial"); textRange.getCharacterFormat().setFontSize(10); -//Accessthe instance of the cell (third row, first cell) and add the content into cell. +//Access the instance of the cell (third row, first cell) and add the content into cell. textRange = table.get(2, 0).addParagraph().appendText("Orange"); textRange.getCharacterFormat().setFontName("Arial"); textRange.getCharacterFormat().setFontSize(10); @@ -410,7 +410,7 @@ The following code example illustrates how to enable and disable the special tab WordDocument document = new WordDocument("Table.docx",FormatType.Docx); WSection section = document.getSections().get(0); WTable table = section.getTables().get(0); -//Apply"LightShading" built-in style to table. +//Apply "LightShading" built-in style to table. table.applyStyle(BuiltinTableStyle.LightShading); //Enable special formatting for banded columns of the table. table.setApplyStyleForBandedColumns(true); @@ -748,7 +748,6 @@ for(Object row_tempObj : table.getRows()) //Save and close the document instance. document.save("Sample.docx",FormatType.Docx); document.close(); -document.Close(); {% endhighlight %} {% endtabs %} diff --git a/java-file-formats/word-library/working-with-word-document.md b/java-file-formats/word-library/working-with-word-document.md index 9f40f20..e0da654 100644 --- a/java-file-formats/word-library/working-with-word-document.md +++ b/java-file-formats/word-library/working-with-word-document.md @@ -156,7 +156,7 @@ private void iterateTextBody(WTextBody textBody)throws Exception //Process the paragraph contents. //Iterate through the paragraph's DOM. WParagraph paragraph = (WParagraph)bodyItemEntity; - terateParagraph(paragraph.getItems()); + iterateParagraph(paragraph.getItems()); break; case "Table": //Table is a collection of rows and cells.