Skip to content

Commit cf17ffc

Browse files
Merge pull request #2512 from syncfusion-content/503504-UG-Updation-HF
503504: Added changes in Web API UG documentation
2 parents bad60e9 + 461d2fe commit cf17ffc

3 files changed

Lines changed: 79 additions & 75 deletions

File tree

Document-Processing/Web-apis/consume-apis/html-to-pdf.md

Lines changed: 77 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ documentation: UG
99

1010
The Syncfusion HTML to PDF Web API allows you to convert web content into high‑quality PDF documents. It supports converting both static HTML templates and live web pages via URLs, ensuring accurate rendering of layouts, styles, images, and fonts. When converting an HTML template, you need to provide the main HTML file along with its dependent assets such as CSS files, images, fonts, and scripts, so the engine can fully render the content as it appears in a browser.
1111

12-
## Convert HTML to PDF
12+
## Convert HTML URL to PDF
1313

1414
To convert HTML to PDF, send a request to the /v1/conversion/html-to-pdf endpoint, including the webpage URL as input as follows:
1515

@@ -121,80 +121,8 @@ Console.WriteLine(await response.Content.ReadAsStringAsync());
121121

122122
{% endtabs %}
123123

124-
## HTML to PDF settings
125-
**PaperSize**
126-
127-
Defines the page size for the generated PDF (e.g., A4, Letter).
128-
129-
**Assets**
130-
131-
Specifies additional resources—such as CSS files, images, and fonts—required for converting HTML templates.
132-
133-
**IndexFile**
134-
135-
Indicates the main HTML file that serves as the entry point for the conversion.
136-
137-
**Settings**
138-
139-
Provides rendering and conversion options for the Blink engine used during HTML to PDF processing.
140-
141-
**RenderingEngine**
142-
143-
Specifies the browser engine used to render HTML content before generating the PDF.
144-
145-
**Url**
146-
147-
Defines the source URL or HTML location to be converted into a PDF.
148-
149-
**Orientation**
150-
151-
Defines the page orientation of the PDF, such as Portrait or Landscape.
152-
153-
**Rotation**
154-
155-
Specifies the rotation angle applied to the pages in the generated PDF.
156-
157-
**Margins**
158-
159-
Configures the margin size for all sides of each PDF page.
160-
161-
**AdditionalDelay**
162-
163-
Adds a wait time (in milliseconds) before conversion to ensure dynamic content fully loads.
164-
165-
**EnableLinks**
166-
167-
Preserves active, clickable hyperlinks within the generated PDF.
168-
169-
**EnableScripts**
170-
171-
Allows JavaScript execution during HTML rendering for dynamic content support.
172-
173-
**EnableForms**
174-
175-
Enables interactive form fields in the generated PDF document.
176-
177-
**EnableToc**
178-
179-
Generates a table of contents based on the HTML document structure.
124+
## Convert HTML File to PDF
180125

181-
**EnableBookmarks**
182-
183-
Creates PDF bookmarks for easier navigation within the document.
184-
185-
**SinglePagePdf**
186-
187-
Renders the entire HTML content into one continuous PDF page.
188-
189-
**ShowHeader**
190-
191-
Displays header content on each page of the generated PDF.
192-
193-
**ShowFooter**
194-
195-
Displays footer content on each page of the generated PDF.
196-
197-
## HTML to PDF Job Response
198126
To convert HTML to PDF, send a request to the /v1/conversion/html-to-pdf endpoint, including both the HTML file as input and its assets as follows:
199127

200128
{% tabs %}
@@ -318,6 +246,81 @@ Console.WriteLine(await response.Content.ReadAsStringAsync());
318246

319247
{% endtabs %}
320248

249+
## HTML to PDF settings
250+
**PaperSize**
251+
252+
Defines the page size for the generated PDF (e.g., A4, Letter).
253+
254+
**Assets**
255+
256+
Specifies additional resources—such as CSS files, images, and fonts—required for converting HTML templates.
257+
258+
**IndexFile**
259+
260+
Indicates the main HTML file that serves as the entry point for the conversion.
261+
262+
**Settings**
263+
264+
Provides rendering and conversion options for the Blink engine used during HTML to PDF processing.
265+
266+
**RenderingEngine**
267+
268+
Specifies the browser engine used to render HTML content before generating the PDF.
269+
270+
**Url**
271+
272+
Defines the source URL or HTML location to be converted into a PDF.
273+
274+
**Orientation**
275+
276+
Defines the page orientation of the PDF, such as Portrait or Landscape.
277+
278+
**Rotation**
279+
280+
Specifies the rotation angle applied to the pages in the generated PDF.
281+
282+
**Margins**
283+
284+
Configures the margin size for all sides of each PDF page.
285+
286+
**AdditionalDelay**
287+
288+
Adds a wait time (in milliseconds) before conversion to ensure dynamic content fully loads.
289+
290+
**EnableLinks**
291+
292+
Preserves active, clickable hyperlinks within the generated PDF.
293+
294+
**EnableScripts**
295+
296+
Allows JavaScript execution during HTML rendering for dynamic content support.
297+
298+
**EnableForms**
299+
300+
Enables interactive form fields in the generated PDF document.
301+
302+
**EnableToc**
303+
304+
Generates a table of contents based on the HTML document structure.
305+
306+
**EnableBookmarks**
307+
308+
Creates PDF bookmarks for easier navigation within the document.
309+
310+
**SinglePagePdf**
311+
312+
Renders the entire HTML content into one continuous PDF page.
313+
314+
**ShowHeader**
315+
316+
Displays header content on each page of the generated PDF.
317+
318+
**ShowFooter**
319+
320+
Displays footer content on each page of the generated PDF.
321+
322+
## HTML to PDF Job Response
323+
321324
Once the request is sent, it will create a conversion job to convert HTML to PDF and return the job details as follows:
322325

323326
```

Document-Processing/Web-apis/consume-apis/ocr-pdf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Specifies one or more OCR recognition languages for accurate text extraction. Th
113113

114114
Multiple languages can be provided by combining their codes using the `+` (plus) separator.
115115

116-
Supported languages:
116+
**Supported languages:**
117117

118118
| Code | Language |
119119
|---|---|

Document-Processing/Web-apis/consume-apis/overview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ The document Processing API provides following capabilities
2727
- [PDF to Image](https://help.syncfusion.com/document-processing/web-apis/consume-apis/pdf-to-image)
2828
- [XPS to PDF](https://help.syncfusion.com/document-processing/web-apis/consume-apis/xps-to-pdf)
2929
- [Organize PDF](https://help.syncfusion.com/document-processing/web-apis/consume-apis/organize-pdf)
30+
- [OCR PDF](https://help.syncfusion.com/document-processing/web-apis/consume-apis/ocr-pdf)
3031

3132

3233
N> The Syncfusion Document Processing API is now available as a Docker-based solution. [Try it out](https://hub.docker.com/r/syncfusion/document-processing-apis)

0 commit comments

Comments
 (0)