Skip to content
This repository has been archived by the owner. It is now read-only.

DocIO.md

Latest commit

 

History

History
514 lines (411 loc) · 14.7 KB

DocIO.md

File metadata and controls

514 lines (411 loc) · 14.7 KB
layout post
title webAPI reference for DocIO
description webAPI reference for DocIO
documentation ug
platform js
keywords DocIO, syncfusion, DocIO webapi

GenerateWordDocument

[POST] /Api/DocIO/GenerateWordDocument

It is used to create a simple Word document with text, image and tables.

URL parameters

Parameter Data Type Description
FormatType String It contains format type to save.

Response information

Code: 200

Access-Control-Allow-Origin: *

Content-Type: data:attachment/filetype

Code example

{% highlight js %}

URL: http://js.syncfusion.com/demos/ejServices/api/DocIO/GenerateWordDocument

<script> $('#generatedocument').click(function () { var formdata = new FormData(); var rdButtonDoc = document.getElementById("rdButtonDoc").checked; var rdButtonDocx = document.getElementById("rdButtonDocx").checked; var rdButtonWordML = document.getElementById("rdButtonWordML").checked; var rdButtonPdf = document.getElementById("rdButtonPdf").checked; var contenttype; var filename; if (rdButtonDoc) { formdata.append("FormatType", "WordDoc"); contenttype = "data:attachment/doc"; filename = "Sample.doc"; } else if(rdButtonDocx) { formdata.append("FormatType", "WordDocx"); contenttype = "data:attachment/docx"; filename = "Sample.docx"; } else if(rdButtonWordML) { formdata.append("FormatType", "WordML"); contenttype = "data:attachment/xml"; filename = "Sample.xml"; } else if(rdButtonPdf) { formdata.append("FormatType", "Pdf"); contenttype = "data:attachment/pdf"; filename = "Sample.pdf"; } var req = new XMLHttpRequest(); req.open("POST", window.baseurl + "api/DocIO/GenerateWordDocument", true); req.send(formdata); req.responseType = "blob"; req.onload = function (event) { if (req.response != null && navigator.msSaveBlob) return navigator.msSaveBlob(new Blob([req.response], { type: contenttype}), filename); var a = document.createElement('a'); var fileLink = window.URL.createObjectURL(new Blob([req.response], {type: contenttype})); a.href = fileLink; a.download = filename; document.body.appendChild(a); a.click(); window.URL.revokeObjectURL(fileLink); a.remove(); }; }); </script>

{% endhighlight %}

The above example will generate Word document or PDF.

ConvertToPDF

[POST] /Api/DocIO/ConvertToPDF

It is used to convert Word document to PDF.

URL parameters

| Parameter | Data Type | Data Type | Description | |---|---|---| |UploadedFile|File|It contains uploaded file to convert as PDF.|

Response information

Code: 200

Access-Control-Allow-Origin: *

Content-Type: data:attachment/pdf

Code example

{% highlight js %}

URL: http://js.syncfusion.com/demos/ejServices/api/DocIO/ConvertToPDF

<script> $('#ConvertToPDF').click(function () { var formData = new FormData(); var files = $("#InputFile").get(0).files; // Add the uploaded image content to the form data collection if (files.length > 0) { formData.append("UploadedFile", files[0]); } var req = new XMLHttpRequest(); req.open("POST", window.baseurl + "api/DocIO/ConvertToPDF", true); req.send(formData); req.responseType = "blob"; req.onload = function (event) { if (req.response != null && navigator.msSaveBlob) return navigator.msSaveBlob(new Blob([req.response], { type: "data:attachment/pdf" }), "Sample.pdf"); var a = document.createElement('a'); var fileLink = window.URL.createObjectURL(new Blob([req.response], {type: "data:attachment/pdf"})); a.href = fileLink; a.download = "Sample.pdf"; document.body.appendChild(a); a.click(); window.URL.revokeObjectURL(fileLink); a.remove(); }; }); </script>

{% endhighlight %}

The above example will result PDF document being converted from Word document.

ApplyTextFormat

[POST] P/Api/DocIO/ApplyTextFormat

It is used to generate Word Document with various text formats such as character/text level formatting, paragraph level formatting and list level formatting.

URL parameters

Parameter Data Type Description
FormatType String It contains format type to save.

Response information

Code: 200

Access-Control-Allow-Origin: *

Content-Type: data:attachment/filetype

Code example

{% highlight js %}

URL: http://js.syncfusion.com/demos/ejServices/api/DocIO/ApplyTextFormat

<script> $('#generatedocument').click(function () { var formData = new FormData(); var rdButtonDoc = document.getElementById("rdButtonDoc").checked; var rdButtonDocx = document.getElementById("rdButtonDocx").checked; var rdButtonWordML = document.getElementById("rdButtonWordML").checked; var rdButtonPdf = document.getElementById("rdButtonPdf").checked; var contentType; var fileName; if (rdButtonDoc) { formData.append("FormatType", "WordDoc"); contentType = "data:attachment/doc"; fileName = "Sample.doc"; } else if(rdButtonDocx) { formData.append("FormatType", "WordDocx"); contentType = "data:attachment/docx"; fileName = "Sample.docx"; } else if(rdButtonWordML) { formData.append("FormatType", "WordML"); contentType = "data:attachment/xml"; fileName = "Sample.xml"; } else if(rdButtonPdf) { formData.append("FormatType", "Pdf"); contentType = "data:attachment/pdf"; fileName = "Sample.pdf"; } var req = new XMLHttpRequest(); req.open("POST", window.baseurl + "api/DocIO/ApplyTextFormat", true); req.send(formData); req.responseType = "blob"; req.onload = function (event) { if (req.response != null && navigator.msSaveBlob) return navigator.msSaveBlob(new Blob([req.response], { type: contentType}), fileName); var a = document.createElement('a'); var fileLink = window.URL.createObjectURL(new Blob([req.response], {type: contentType})); a.href = fileLink; a.download = fileName; document.body.appendChild(a); a.click(); window.URL.revokeObjectURL(fileLink); a.remove(); }; }); </script>

{% endhighlight %}

The above example will generate Word document or PDF.

GetInvoiceTemplate

[POST] /Api/DocIO/GetInvoiceTemplate

It is used to get invoice template Word document.

Response information

Code: 200

Access-Control-Allow-Origin: *

Content-Type: data:attachment/doc

Code example

{% highlight js %}

URL: http://js.syncfusion.com/demos/ejServices/api/DocIO/GetInvoiceTemplate

<script> $('#viewtemplate').click(function () { var req = new XMLHttpRequest(); req.open("POST", window.baseurl + "api/DocIO/GetInvoiceTemplate", true); req.responseType = "blob"; req.send(); req.onload = function (event) { if (req.response != null && navigator.msSaveBlob) return navigator.msSaveBlob(new Blob([req.response], { type: "data:attachment/doc"}), "SalesInvoiceTemplate.doc"); var a = document.createElement('a'); var fileLink = window.URL.createObjectURL(new Blob([req.response], {type: "data:attachment/doc"})); a.href = fileLink; a.download = "SalesInvoiceTemplate.doc"; document.body.appendChild(a); a.click(); window.URL.revokeObjectURL(fileLink); a.remove(); }; }); </script>

{% endhighlight %}

The above example will generate invoice template Word document.

GenerateInvoice

[POST] Api/DocIO/GenerateInvoice

It is used to generate sales invoice report using Mail merge functionality.

URL parameters

Parameter Data Type Description
FormatType String It contains format type to save.

Response information

Code: 200

Access-Control-Allow-Origin: *

Content-Type: data:attachment/filetype

Code example

{% highlight js %}

URL: http://js.syncfusion.com/demos/ejServices/api/DocIO/GenerateInvoice

<script> $('#generate').click(function () { var formData = new FormData(); var id = document.getElementById('order'); formData.append("Id", id.options[id.selectedIndex].value); var rdButtonDoc = document.getElementById("rdButtonDoc").checked; var rdButtonDocx = document.getElementById("rdButtonDocx").checked; var rdButtonWordML = document.getElementById("rdButtonWordML").checked; var rdButtonPdf = document.getElementById("rdButtonPdf").checked; var contentType; var fileName; if (rdButtonDoc) { formData.append("FormatType", "WordDoc"); contentType = "data:attachment/doc"; fileName = "Sample.doc"; } else if(rdButtonDocx) { formData.append("FormatType", "WordDocx"); contentType = "data:attachment/docx"; fileName = "Sample.docx"; } else if(rdButtonWordML) { formData.append("FormatType", "WordML"); contentType = "data:attachment/xml"; fileName = "Sample.xml"; } else { formData.append("FormatType", "Pdf"); contentType = "data:attachment/pdf"; fileName = "Sample.pdf"; } var req = new XMLHttpRequest(); req.open("POST", window.baseurl + "api/DocIO/GenerateInvoice", true); req.responseType = "blob"; req.send(formData); req.onload = function (event) { if (req.response != null && navigator.msSaveBlob) return navigator.msSaveBlob(new Blob([req.response], { type: contentType }), fileName); var a = document.createElement('a'); var fileLink = window.URL.createObjectURL(new Blob([req.response], {type: contentType})); a.href = fileLink; a.download = fileName; document.body.appendChild(a); a.click(); window.URL.revokeObjectURL(fileLink); a.remove(); }; }); </script>

{% endhighlight %}

The above example will generate Word document or PDF.

GetMailmergeTemplate

[POST] /Api/DocIO/GetMailmergeTemplate

It is used to get Mail merge template Word Document.

URL parameters

Parameter Data Type Description
Template String It contains type of Template document.

Response information

Code: 200

Access-Control-Allow-Origin: *

Content-Type: data:attachment/doc

Code example

{% highlight js %}

URL: http://js.syncfusion.com/demos/ejServices/api/DocIO/GetMailmergeTemplate

<script> var formdata; $('#viewtemplate').click(function () { formdata = new FormData(); var rdButtonReport = document.getElementById("rdButtonReport").checked; var rdButtonLetter = document.getElementById("rdButtonLetter").checked; var template; if(rdButtonReport) template = "Report"; else template = "Letter"; formdata.append("Template", template); var req = new XMLHttpRequest(); req.open("POST", window.baseurl + "api/DocIO/GetMailmergeTemplate", true); req.send(formdata); req.responseType = "blob"; req.onload = function (event) { if (req.response != null && navigator.msSaveBlob) return navigator.msSaveBlob(new Blob([req.response], { type: "data:attachment/doc"}), "Template.doc"); var a = document.createElement('a'); var fileLink = window.URL.createObjectURL(new Blob([req.response], {type: "data:attachment/doc"})); a.href = fileLink; a.download = "Template.doc"; document.body.appendChild(a); a.click(); window.URL.revokeObjectURL(fileLink); a.remove(); }; }); </script>

{% endhighlight %}

The above example will generate Mail merge template Word document.

ExecuteNestedMailmerge

[POST] /Api/DocIO/ExecuteNestedMailmerge

It is used to perform Mail merge for nested groups in Word Document.

URL parameters

Parameter Data Type Description
Template String It contains type of Template document.
Data String It contains type of Data.
FormatType String It contains format type to save.

Response information

Code: 200

Access-Control-Allow-Origin: *

Content-Type: data:attachment/doc

Code example

{% highlight js %}

URL: http://js.syncfusion.com/demos/ejServices/api/DocIO/ExecuteNestedMailmerge

<script> var formData; $('#generate').click(function () { formData = new FormData(); var rdButtonReport = document.getElementById("rdButtonReport").checked; var rdButtonLetter = document.getElementById("rdButtonLetter").checked; var template; if(rdButtonReport) template = "Report"; else template = "Letter"; formData.append("Template", template); var rdImplicit = document.getElementById("rdImplicit").checked; var rdExplicit = document.getElementById("rdExplicit").checked; if(rdImplicit) formData.append("Data", "Implicit"); else if(rdExplicit) formData.append("Data", "Explicit"); var rdButtonDoc = document.getElementById("rdButtonDoc").checked; var rdButtonDocx = document.getElementById("rdButtonDocx").checked; var rdButtonWordML = document.getElementById("rdButtonWordML").checked; var rdButtonPdf = document.getElementById("rdButtonPdf").checked; var contentType; var fileName; if (rdButtonDoc) { formData.append("FormatType", "WordDoc"); contentType = "data:attachment/doc"; fileName = "Sample.doc"; } else if(rdButtonDocx) { formData.append("FormatType", "WordDocx"); contentType = "data:attachment/docx"; fileName = "Sample.docx"; } else if(rdButtonWordML) { formData.append("FormatType", "WordML"); contentType = "data:attachment/xml"; fileName = "Sample.xml"; } else { formData.append("FormatType", "Pdf"); contentType = "data:attachment/pdf"; fileName = "Sample.pdf"; } var req = new XMLHttpRequest(); req.open("POST", window.baseurl + "api/DocIO/ExecuteNestedMailmerge", true); req.send(formData); req.responseType = "blob"; req.onload = function (event) { if (req.response != null && navigator.msSaveBlob) return navigator.msSaveBlob(new Blob([req.response], { type: contentType}), fileName); var a = document.createElement('a'); var fileLink = window.URL.createObjectURL(new Blob([req.response], {type: contentType})); a.href = fileLink; a.download = fileName; document.body.appendChild(a); a.click(); window.URL.revokeObjectURL(fileLink); a.remove(); }; }); </script>

{% endhighlight %}

The above example will generate Word document or PDF.