Merge pull request #1 from DharaniThangarasu/Add-Find-Replace-Sample

Added example for find and replace in word document

Author: gunasekarant

README.md

@@ -1,2 +1,68 @@
 # Java-Word-Find-and-Replace-Examples
-Find and replace text in a Word document in Java without Microsoft Word or interop.
+
+This repository contains examples that illustrates how to find and replace text in Word documents programmatically in Java using [Syncfusion’s Java Word library](https://www.syncfusion.com/word-framework/java/word-library?utm_source=github&utm_medium=listing&utm_campaign=java-create-word-examples) (Essential DocIO) without Microsoft Word or Office interop dependencies.
+
+## Find and replace text in Word documents using Java
+
+The Syncfusion Java Word library (Essential DocIO) provides comprehensive APIs to find and replace text in a Word document with any desired text, image, hyperlink, paragraph, table, and part of a document or an entire document. It provides options to find text by matching case and whole words. You can find each occurrence one by one or all the occurrences of a text in the document. It saves your efforts and time by helping you to automate find and replace a pattern of text in a Word document using [Regex](https://docs.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.regex). It allows you to save the resultant document as Word document (DOCX, WordML), HTML, RTF.
+
+## Jar files
+
+You can download the jars from the Syncfusion [maven repository](https://jars.syncfusion.com/?_ga=2.177721445.1332356717.1617771042-23317178.1569844681) 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.
+
+## Key Features
+
+- [Find and highlight text in Java](findandhighlighttext/) - Find text from a Word document and format or highlight it.
+
+- [Find and replace text in Java](findandreplacetext/) - Find text from a Word document and replace it with another text.
+
+- [Replace text with image in Java](replacetextwithimage/) - Find a placeholder text from a Word document and replace it with any desired image.
+
+- [Replace text with merge field in Java](replacetextwithmergefield/) - Find a pattern of text from a Word document and replace it with merge fields.
+
+- [Replace text with table in Java](replacetextwithtable/) - Find a placeholder text from a Word document and replace it with a table.
+
+- [Replace text with document in Java](replacetextwithdocument/) - Find text from a Word document and replace it with another Word document.
+
+- [Find and replace several paragraphs in Java](findandreplaceseveralparagraphs/) - Find text that extends to several paragraphs in a Word document and replace it with another Word document.
+
+## Screenshots
+
+**Find and highlight text**
+
+<p align="center"> 
+<img src="screenshots/Find-and-highlight-text.png" alt="Find text from a Word document and format or highlight it in Java"/> 
+</p>
+
+**Find and replace text**
+
+<p align="center"> 
+<img src="screenshots/Replace-misspelt-word.png" alt="Find a misspelt word from a Word document and replace it with desired word in Java"/> 
+</p>
+
+**Replace text with table**
+
+<p align="center"> 
+<img src="screenshots/Replace-text-with-table.png" alt="Find text from a Word document and replace it with a table in Java"/> 
+</p>
+
+# Resources
+
+- **Product page:** [Syncfusion Java Word Framework](https://www.syncfusion.com/word-framework/java?utm_source=github&utm_medium=listing&utm_campaign=java-create-word-examples)
+
+- **Documentation:** [Find and Replace using Syncfusion Java Word library](https://help.syncfusion.com/java-file-formats/word-library/working-with-find-and-replace)
+
+- **Online demo:** [Essential DocIO demos](https://github.com/syncfusion/java-demos?utm_source=github&utm_medium=listing&utm_campaign=java-create-word-examples)
+
+- **Download:** [Syncfusion File Formats Controls](https://www.syncfusion.com/sales/products/fileformats?utm_source=github&utm_medium=listing&utm_campaign=java-create-word-examples)
+
+# Support and feedback
+
+* For queries, contact our [Syncfusion support team](https://www.syncfusion.com/support/directtrac/incidents/newincident?utm_source=github&utm_medium=listing&utm_campaign=java-create-word-examples) or post the queries through [community forums](https://www.syncfusion.com/forums?utm_source=github&utm_medium=listing&utm_campaign=java-create-word-examples).
+
+* To renew the subscription, click [here](https://www.syncfusion.com/sales/products?utm_source=github&utm_medium=listing&utm_campaign=java-create-word-examples) or contact our sales team at [salessupport@syncfusion.com](mailto:salessupport@syncfusion.com).
+
+# License
+
+This is a commercial product and requires a paid license for possession or use. Syncfusion’s licensed software, including this component, is subject to the terms and conditions of [Syncfusion's EULA](https://www.syncfusion.com/eula/es?utm_source=github&utm_medium=listing&utm_campaign=java-create-word-examples). You can purchase a license [here](https://www.syncfusion.com/sales/products?utm_source=github&utm_medium=listing&utm_campaign=java-create-word-examples) or start a free 30-day trial [here](https://www.syncfusion.com/account/manage-trials/start-trials?utm_source=github&utm_medium=listing&utm_campaign=java-create-word-examples).
+

findandhighlighttext/FindAndHighlightText.java

@@ -0,0 +1,37 @@
+import java.io.*;
+import com.syncfusion.docio.*;
+import com.syncfusion.javahelper.system.drawing.ColorSupport;
+
+public class FindAndHighlightText {
+
+	public static void main(String[] args) throws Exception {
+		// Opens the input Word document.
+		WordDocument document = new WordDocument(getDataDir("FindAndHighlightText_Template.docx"), FormatType.Docx);
+		// Finds all occurrence of the text in the Word document.
+		TextSelection[] textSelections = document.findAll("Adventure", true, true);
+		for (int i = 0; i < textSelections.length; i++) {
+			// Sets the highlight color for the searched text as Yellow.
+			textSelections[(int) i].getAsOneRange().getCharacterFormat().setHighlightColor(ColorSupport.getYellow());
+		}
+		// Saves the Word document
+		document.save("Result.docx");
+		// Closes the document
+		document.close();
+	}
+
+	/**
+	 * Get the file path
+	 * 
+	 * @param path specifies the file path
+	 */
+	private static String getDataDir(String path) {
+		File dir = new File(System.getProperty("user.dir"));
+		if (!(dir.toString().endsWith("Java-Word-Find-and-Replace-Examples")))
+			dir = dir.getParentFile();
+		dir = new File(dir, "resources");
+		dir = new File(dir, path);
+		if (dir.isDirectory() == false)
+			dir.mkdir();
+		return dir.toString();
+	}
+}

findandreplaceseveralparagraphs/FindAndReplaceSeveralParagraphs.java

@@ -0,0 +1,46 @@
+import java.io.*;
+import com.syncfusion.docio.*;
+
+public class FindAndReplaceSeveralParagraphs {
+
+	public static void main(String[] args) throws Exception {
+		// Opens the input Word document.
+		WordDocument document = new WordDocument(getDataDir("FindAndReplaceSeveralParagraphs_Template.docx"),
+				FormatType.Docx);
+		WordDocument subDocument = new WordDocument(getDataDir("Source.docx"), FormatType.Docx);
+		// Gets the content from another Word document to replace.
+		TextBodyPart replacePart = new TextBodyPart(subDocument);
+		for (Object bodyItem_tempObj : subDocument.getLastSection().getBody().getChildEntities()) {
+			TextBodyItem bodyItem = (TextBodyItem) bodyItem_tempObj;
+			replacePart.getBodyItems().add(bodyItem.clone());
+		}
+		String placeholderText = "Suppliers/Vendors of Northwind" + "Customers of Northwind"
+				+ "Employee details of Northwind traders" + "The product information" + "The inventory details"
+				+ "The shippers" + "Purchase Order transactions" + "Sales Order transaction" + "Inventory transactions"
+				+ "Invoices" + "[end replace]";
+		// Finds the text that extends to several paragraphs and replaces it with
+		// desired content.
+		document.replaceSingleLine(placeholderText, replacePart, false, false);
+		subDocument.close();
+		// Saves the Word document
+		document.save("Result.docx");
+		// Closes the document
+		document.close();
+	}
+
+	/**
+	 * Get the file path
+	 * 
+	 * @param path specifies the file path
+	 */
+	private static String getDataDir(String path) {
+		File dir = new File(System.getProperty("user.dir"));
+		if (!(dir.toString().endsWith("Java-Word-Find-and-Replace-Examples")))
+			dir = dir.getParentFile();
+		dir = new File(dir, "resources");
+		dir = new File(dir, path);
+		if (dir.isDirectory() == false)
+			dir.mkdir();
+		return dir.toString();
+	}
+}

findandreplacetext/FindAndReplaceText.java

@@ -0,0 +1,31 @@
+import java.io.File;
+import com.syncfusion.docio.*;
+
+public class FindAndReplaceText {
+
+	public static void main(String[] args) throws Exception {
+		// Opens the input Word document.
+		WordDocument document = new WordDocument(getDataDir("FindAndReplaceText_Template.docx"));
+		// Finds all occurrences of a misspelled word and replaces with properly spelled word.
+		document.replace("Cyles", "Cycles", true, true);
+		// Saves the resultant file in the given path.
+		document.save("Result.docx");
+		document.close();
+	}
+
+	/**
+	 * Get the file path
+	 * 
+	 * @param path specifies the file path
+	 */
+	private static String getDataDir(String path) {
+		File dir = new File(System.getProperty("user.dir"));
+		if (!(dir.toString().endsWith("Java-Word-Find-and-Replace-Examples")))
+			dir = dir.getParentFile();
+		dir = new File(dir, "resources");
+		dir = new File(dir, path);
+		if (dir.isDirectory() == false)
+			dir.mkdir();
+		return dir.toString();
+	}
+}

replacetextwithdocument/ReplaceTextWithDocument.java

@@ -0,0 +1,42 @@
+import java.io.*;
+import java.util.regex.Pattern;
+import com.syncfusion.docio.*;
+import com.syncfusion.javahelper.system.*;
+import com.syncfusion.javahelper.system.text.regularExpressions.MatchSupport;
+
+public class ReplaceTextWithDocument {
+
+	public static void main(String[] args) throws Exception {
+		// Opens the Word template document
+		WordDocument document = new WordDocument(getDataDir("ReplaceTextWithDocument_Template.docx"), FormatType.Docx);
+		TextSelection[] textSelections = document.findAll(Pattern.compile(MatchSupport.trimPattern("\\[(.*)\\]")));
+		for (int i = 0; i < textSelections.length; i++) {
+			WordDocument subDocument = new WordDocument(getDataDir(
+					StringSupport.trimEnd(StringSupport.trimStart(textSelections[i].getSelectedText(), '['), ']')
+							+ ".docx"),
+					FormatType.Docx);
+			document.replace(textSelections[(int) i].getSelectedText(), subDocument, true, true);
+			subDocument.close();
+		}
+		// Saves the Word document
+		document.save("Result.docx");
+		// Closes the document
+		document.close();
+	}
+
+	/**
+	 * Get the file path
+	 * 
+	 * @param path specifies the file path
+	 */
+	private static String getDataDir(String path) {
+		File dir = new File(System.getProperty("user.dir"));
+		if (!(dir.toString().endsWith("Java-Word-Find-and-Replace-Examples")))
+			dir = dir.getParentFile();
+		dir = new File(dir, "resources");
+		dir = new File(dir, path);
+		if (dir.isDirectory() == false)
+			dir.mkdir();
+		return dir.toString();
+	}
+}

replacetextwithimage/ReplaceTextWithImage.java

@@ -0,0 +1,44 @@
+import java.io.*;
+import java.util.regex.*;
+import com.syncfusion.docio.*;
+import com.syncfusion.javahelper.system.text.regularExpressions.MatchSupport;
+
+public class ReplaceTextWithImage {
+
+	public static void main(String[] args) throws Exception {
+		//Opens the input Word document.
+		WordDocument document = new WordDocument(getDataDir("FindAndReplaceImage_Template.docx"));
+		//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.
+			WParagraph paragraph = new WParagraph(document);
+			WPicture picture = (WPicture) paragraph
+					.appendPicture(new FileInputStream(getDataDir(textSelections[i].getSelectedText() + ".png")));
+			TextSelection newSelection = new TextSelection(paragraph, 0, 1);
+			TextBodyPart bodyPart = new TextBodyPart(document);
+			bodyPart.getBodyItems().add(paragraph);
+			document.replace(textSelections[i].getSelectedText(), bodyPart, true, true);
+		}
+		//Saves the resultant file in the given path.
+		document.save("Result.docx");
+		document.close();
+
+	}
+
+	/**
+	 * Get the file path
+	 * 
+	 * @param path specifies the file path
+	 */
+	private static String getDataDir(String path) {
+		File dir = new File(System.getProperty("user.dir"));
+		if (!(dir.toString().endsWith("Java-Word-Find-and-Replace-Examples")))
+			dir = dir.getParentFile();
+		dir = new File(dir, "resources");
+		dir = new File(dir, path);
+		if (dir.isDirectory() == false)
+			dir.mkdir();
+		return dir.toString();
+	}
+}

replacetextwithmergefield/ReplaceTextWithMergeField.java

@@ -0,0 +1,50 @@
+import java.io.*;
+import java.util.regex.Pattern;
+import com.syncfusion.docio.*;
+import com.syncfusion.javahelper.system.*;
+import com.syncfusion.javahelper.system.text.regularExpressions.MatchSupport;
+
+public class ReplaceTextWithMergeField {
+
+	public static void main(String[] args) throws Exception {
+		// Opens the input Word document.
+		WordDocument document = new WordDocument(getDataDir("ReplaceWithMergeFileds_Template.docx"));
+		// Finds all the placeholder text enclosed within '«' and '»' in the Word document.
+		TextSelection[] textSelections = document.findAll(
+				Pattern.compile(MatchSupport.trimPattern("«([(?i)image(?-i)]*:*[a-zA-Z0-9 ]*:*[a-zA-Z0-9 ]+)»")));
+		String[] searchedPlaceholders = new String[textSelections.length];
+		for (int i = 0; i < textSelections.length; i++) {
+			searchedPlaceholders[(int) i] = textSelections[(int) i].getSelectedText();
+		}
+		for (int i = 0; i < searchedPlaceholders.length; i++) {
+			WParagraph paragraph = new WParagraph(document);
+			// Replaces the placeholder text enclosed within '«' and '»' with desired merge field.
+			paragraph.appendField(
+					StringSupport.trimEnd(StringSupport.trimStart(searchedPlaceholders[i], '«'), '»'),
+					FieldType.FieldMergeField);
+			TextSelection newSelection = new TextSelection(paragraph, 0, paragraph.getItems().getCount());
+			TextBodyPart bodyPart = new TextBodyPart(document);
+			bodyPart.getBodyItems().add(paragraph);
+			document.replace(searchedPlaceholders[(int) i], bodyPart, true, true, true);
+		}
+		// Saves the resultant file in the given path.
+		document.save("Result.docx");
+		document.close();
+	}
+
+	/**
+	 * Get the file path
+	 * 
+	 * @param path specifies the file path
+	 */
+	private static String getDataDir(String path) {
+		File dir = new File(System.getProperty("user.dir"));
+		if (!(dir.toString().endsWith("Java-Word-Find-and-Replace-Examples")))
+			dir = dir.getParentFile();
+		dir = new File(dir, "resources");
+		dir = new File(dir, path);
+		if (dir.isDirectory() == false)
+			dir.mkdir();
+		return dir.toString();
+	}
+}