Skip to content

Commit 2e8dac9

Browse files
sivasubramanvDeepakRajSundar
authored andcommitted
Merge branch 'WF-57082-UG_Documentation_For_Java' into 'hotfix/hotfix-v18.3.0.35'
WF-57082_Resolved build errors See merge request content/java-file-format-docs!26 (cherry picked from commit 1831871) aa5a093 Modified the Getting started code snippet and images 15e0d63 WF-57082-Added hyperlink f3af3bb WF-57082-Added FAQ and supported-and-unsupported-features md files 81df7f8 WF-57082- Modified faq.md files ae44b04 WF-57082-Resolved build error 1b3d9b6 Fixed the image size error in Getting started 95bbdf9 WF-57082-Resolved front matter error eca8177 Merge branch 'WF-57082-UG_Documentation_For_Java' of…
1 parent 4e078e5 commit 2e8dac9

File tree

10 files changed

+51
-50
lines changed

10 files changed

+51
-50
lines changed
15.7 KB
Loading
-114 KB
Loading
-139 KB
Loading

java-file-formats/word-library/accepting-or-rejecting-track-changes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,6 @@ document.close();
172172

173173
Frequently Asked Questions
174174

175-
* How to check whether a Word document contains tracked changes or not?
176-
* How to accept or reject track changes of specific type in the Word document?
177-
* How to enable track changes for Word document?
175+
* [How to check whether a Word document contains tracked changes or not?](https://help.syncfusion.com/java-file-formats/word-library/faq#how-to-check-whether-a-word-document-contains-tracked-changes-or-not)
176+
* [How to accept or reject track changes of specific type in the Word document?](https://help.syncfusion.com/java-file-formats/word-library/faq#how-to-accept-or-reject-track-changes-of-specific-type-in-the-word-document)
177+
* [How to enable track changes for Word document?](https://help.syncfusion.com/java-file-formats/word-library/faq#how-to-enable-track-changes-for-word-document)

java-file-formats/word-library/conversion.md

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -29,36 +29,12 @@ Essential DocIO can convert various flow document as fixed document by using our
2929

3030
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.
3131

32-
For further information kindly refer here.
33-
34-
### Customizing the HTML to Word conversion
35-
36-
You can customize the HTML to Word conversion with the following options:
37-
38-
* Validate the HTML string against XHTML 1.0 Strict and Transitional schema
39-
* Insert the HTML string at the specified position of the document body contents
40-
* Append HTML string to the specified paragraph
41-
42-
For further information kindly refer this link.
43-
44-
### Customizing the Word to HTML conversion
45-
46-
You can customize the Word to HTML conversion with the following options:
47-
48-
* Extract the images used in the HTML document at the specified file directory
49-
* Specify to export the header and footer of the Word document in the HTML
50-
* Specify to consider Text Input field as a editable fields or text
51-
* Specify the CSS style sheet type and its name
52-
53-
N>
54-
While exporting header and footer, DocIO exports the first section header content at the top of the HTML file and first section footer content at the end of the HTML file
55-
56-
For further information kindly refer this link.
32+
For further information kindly refer this [link](https://help.syncfusion.com/java-file-formats/word-library/html#).
5733

5834
### Supported Document elements
5935

60-
Kindly refer to this link for the document elements and attributes that are supported by DocIO in the Word to HTML and HTML to Word conversions.
36+
Kindly refer to this [link](https://help.syncfusion.com/java-file-formats/word-library/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.
6137

6238
## Text file
6339

64-
Essential DocIO supports to convert the Word document into a Text file and vice versa. For further information, kindly refer to this link.
40+
Essential DocIO supports to convert the Word document into a Text file and vice versa. For further information, kindly refer to this [link](https://help.syncfusion.com/java-file-formats/word-library/text#).

java-file-formats/word-library/getting-started.md

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Create a simple Word document in Java | Syncfusion
3-
description: This section illustrate how to create a new Word document from scratch in Java
3+
description: This section illustrate how to create a new Word document from scratch in Java using Syncfusion Java Word library (Essential DocIO)
44
platform: java-file-formats
55
control: Word Library
66
documentation: UG
77
---
8-
# Getting Started
8+
# Getting Started of Word library (DocIO)
99

1010
In this page, you can see how to create a simple Word document by using Syncfusion Java Word library APIs. For creating and manipulating a Word document, the following jar files are required to be referenced in your Java application.
1111

@@ -176,42 +176,66 @@ Essential DocIO allows you to create simple and multi-level lists. The following
176176
{% tabs %}
177177

178178
{% highlight JAVA %}
179-
//Write the default numbered list.
180-
paragraph=section.addParagraph();
179+
//Write the default numbered list.
180+
paragraph = section.addParagraph();
181181
//Set before spacing for paragraph.
182182
paragraph.getParagraphFormat().setBeforeSpacing(6);
183183
paragraph.appendText("Level 0");
184-
//Apply the default numbered list formats.
184+
//Apply the default numbered list formats.
185185
paragraph.getListFormat().applyDefNumberedStyle();
186-
paragraph=section.addParagraph();
186+
//Applies list formatting.
187+
paragraph.getListFormat().getCurrentListLevel().getParagraphFormat().setLeftIndent(36);
188+
paragraph.getListFormat().getCurrentListLevel().getParagraphFormat().setFirstLineIndent(-18);
189+
paragraph.getListFormat().getCurrentListLevel().setNumberAlignment(ListNumberAlignment.Left);
190+
paragraph = section.addParagraph();
187191
paragraph.appendText("Level 1");
188192
//Specify the list format to continue from the last list.
189193
paragraph.getListFormat().continueListNumbering();
190194
//Increment the list level.
191195
paragraph.getListFormat().increaseIndentLevel();
192-
paragraph=section.addParagraph();
196+
//Applies list formatting.
197+
paragraph.getListFormat().getCurrentListLevel().getParagraphFormat().setLeftIndent(72);
198+
paragraph.getListFormat().getCurrentListLevel().getParagraphFormat().setFirstLineIndent(-18);
199+
paragraph.getListFormat().getCurrentListLevel().setNumberAlignment(ListNumberAlignment.Left);
200+
paragraph = section.addParagraph();
193201
paragraph.appendText("Level 0");
194202
//Decrement the list level.
195203
paragraph.getListFormat().continueListNumbering();
196204
paragraph.getListFormat().decreaseIndentLevel();
197-
//Write the default bulleted list.
205+
//Applies list formatting.
206+
paragraph.getListFormat().getCurrentListLevel().getParagraphFormat().setLeftIndent(36);
207+
paragraph.getListFormat().getCurrentListLevel().getParagraphFormat().setFirstLineIndent(-18);
208+
paragraph.getListFormat().getCurrentListLevel().setNumberAlignment(ListNumberAlignment.Left);
209+
//Write the default bulleted list.
198210
section.addParagraph();
199-
paragraph=section.addParagraph();
211+
paragraph = section.addParagraph();
200212
paragraph.appendText("Level 0");
201213
//Apply the default bulleted list formats.
202214
paragraph.getListFormat().applyDefBulletStyle();
203-
paragraph=section.addParagraph();
215+
//Applies list formatting.
216+
paragraph.getListFormat().getCurrentListLevel().getParagraphFormat().setLeftIndent(36);
217+
paragraph.getListFormat().getCurrentListLevel().getParagraphFormat().setFirstLineIndent(-18);
218+
paragraph.getListFormat().getCurrentListLevel().setNumberAlignment(ListNumberAlignment.Left);
219+
paragraph = section.addParagraph();
204220
paragraph.appendText("Level 1");
205221
//Specify the list format to continue from the last list.
206222
paragraph.getListFormat().continueListNumbering();
207223
//Increment the list level.
208224
paragraph.getListFormat().increaseIndentLevel();
209-
paragraph=section.addParagraph();
225+
//Applies list formatting.
226+
paragraph.getListFormat().getCurrentListLevel().getParagraphFormat().setLeftIndent(72);
227+
paragraph.getListFormat().getCurrentListLevel().getParagraphFormat().setFirstLineIndent(-18);
228+
paragraph.getListFormat().getCurrentListLevel().setNumberAlignment(ListNumberAlignment.Left);
229+
paragraph = section.addParagraph();
210230
paragraph.appendText("Level 0");
211231
//Specify the list format to continue from the last list.
212232
paragraph.getListFormat().continueListNumbering();
213233
//Decrement the list level.
214234
paragraph.getListFormat().decreaseIndentLevel();
235+
//Applies list formatting.
236+
paragraph.getListFormat().getCurrentListLevel().getParagraphFormat().setLeftIndent(36);
237+
paragraph.getListFormat().getCurrentListLevel().getParagraphFormat().setFirstLineIndent(-18);
238+
paragraph.getListFormat().getCurrentListLevel().setNumberAlignment(ListNumberAlignment.Left);
215239
section.addParagraph();
216240
{% endhighlight %}
217241

java-file-formats/word-library/overview.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ It is a non-UI component that provides a full-fledged document instance model si
1313

1414
**Key Features**
1515

16-
* Support to create a Word document from scratch.
16+
* Support to [create Word document](https://help.syncfusion.com/java-file-formats/word-library/getting-started) from scratch.
1717
* Support to open, modify, and save the existing Word documents.
18-
* Advanced Mail merge support with different data sources.
19-
* Ability to create or edit Word 2007 and later version documents, and convert them to commonly used file formats such as WordML, TXT, HTML, and vice versa.
20-
* Ability to create and manipulate shapes, and group shape in the DOCX and WordML format documents.
21-
* Ability to read and write the built-in and custom document properties.
22-
* Support to insert and edit the form fields.
23-
* Ability to insert the bookmarks and navigate corresponding bookmarks to insert, replace, and delete content.
18+
* Advanced [Mail merge](https://help.syncfusion.com/java-file-formats/word-library/working-with-mailmerge) support with different data sources.
19+
* 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/java-file-formats/word-library/word-file-formats#word-processing-xml-xml), [TXT](https://help.syncfusion.com/java-file-formats/word-library/text), [HTML](https://help.syncfusion.com/java-file-formats/word-library/html) and vice versa.
20+
* Ability to create and manipulate [shapes](https://help.syncfusion.com/java-file-formats/word-library/working-with-shapes), and [group shape](https://help.syncfusion.com/java-file-formats/word-library/working-with-shapes#grouping-shapes) in the DOCX and WordML format documents.
21+
* Ability to read and write the [built-in and custom document properties](https://help.syncfusion.com/java-file-formats/word-library/working-with-word-document#working-with-word-document-properties).
22+
* Support to insert and edit the [form fields](https://help.syncfusion.com/java-file-formats/word-library/working-with-form-fields).
23+
* Ability to insert the [bookmarks](https://help.syncfusion.com/java-file-formats/word-library/working-with-bookmarks) and navigate corresponding bookmarks to insert, replace, and delete content.
2424

2525
**Compatible Microsoft Word Versions**
2626

java-file-formats/word-library/working-with-fields.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ From v16.1.0.24, the entire field code is included in Document Object Model(DOM)
2323

2424
5. `WFieldMark`: Represents the end of a Field.
2525

26-
Find more information about migration changes here.
26+
Find more information about migration changes [here](https://help.syncfusion.com/file-formats/release-notes/migratingtov16.1.0.24#).
2727

2828
## Adding fields
2929

java-file-formats/word-library/working-with-form-fields.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ paragraph.appendText("Female");
5050
document.save("Checkbox.docx", FormatType.Docx);
5151
//Closes the document
5252
document.close();
53+
{% endhighlight %}
5354

5455
{% endtabs %}
5556

java-file-formats/word-library/working-with-tables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ document.close();
202202

203203
## Align text within a table
204204

205-
You can iterate the cells within a table and align text for each cell. Find more information about iterating the cells from [here](https://help.syncfusion.com/file-formats/docio/working-with-tables#iterating-through-table-elements)
205+
You can iterate the cells within a table and align text for each cell. Find more information about iterating the cells from [here](https://help.syncfusion.com/java-file-formats/word-library/working-with-tables#iterating-through-table-elements)
206206

207207
The following code example illustrates how to align text within a table.
208208

0 commit comments

Comments
 (0)