New to Kendo UI for jQueryStart a free 30-day trial

Pdf

configuration

Configures the Kendo UI Editor PDF export settings.

pdf

Object
<textarea id="editor"></textarea>
<script>
$("#editor").kendoEditor({
    tools: ["pdf"],
    pdf: {
        paperSize: "A4",
        margin: { top: "2cm", left: "1cm", right: "1cm", bottom: "1cm" }
    }
});
</script>

The author of the PDF document.

Default: null

<textarea id="editor"></textarea>
<script>
    $("#editor").kendoEditor({
        tools: ["pdf"],
        pdf: {
            author: "John Doe"
        }
    });
</script>

Specifies if the Print dialog should be opened immediately after loading the document.

Note: Some PDF Readers/Viewers will not allow opening the Print Preview by default, it might be necessary to configure the corresponding add-on or application.

Default: false

<textarea id="editor"></textarea>
<script>
$("#editor").kendoEditor({
    tools: ["pdf"],
    pdf: {
        autoPrint: true
    }
});
</script>
Boolean|String

A flag indicating whether to produce actual hyperlinks in the exported PDF file.

It's also possible to pass a CSS selector as argument. All matching links will be ignored.

Available in versions 2015.3.1020 and later

Default: false

<textarea id="editor"></textarea>
<script>
$("#editor").kendoEditor({
    tools: ["pdf"],
    pdf: {
        avoidLinks: true
    }
});
</script>

The creator of the PDF document.

Default: "Kendo UI PDF Generator"

<textarea id="editor"></textarea>
<script>
    $("#editor").kendoEditor({
        tools: ["pdf"],
        pdf: {
            creator: "John Doe"
        }
    });
</script>

The date when the PDF document is created. Defaults to new Date().

<textarea id="editor"></textarea>
<script>
    $("#editor").kendoEditor({
        tools: ["pdf"],
        pdf: {
            date: new Date("2015/1/31")
        }
    });
</script>

Specifies the file name of the exported PDF file.

Default: "Export.pdf"

<textarea id="editor"></textarea>
<script>
    $("#editor").kendoEditor({
        tools: ["pdf"],
        pdf: {
            fileName: "Document.pdf"
        }
    });
</script>

If set to true, the content will be forwarded to proxyURL even if the browser supports saving files locally.

Default: false

<textarea id="editor"></textarea>
<script>
$("#editor").kendoEditor({
    tools: ["pdf"],
    pdf: {
        forceProxy: true,
        proxyURL: "/save"
    }
});
</script>

Specifies the quality of the images within the exported file, from 0 to 1.

Default: 0.92

<textarea id="editor"></textarea>
<script>
$("#editor").kendoEditor({
    tools: ["pdf"],
    pdf: {
        jpegQuality: 0.8
    }
});
</script>

If set to true all PNG images contained in the exported file will be kept in PNG format.

Default: false

<textarea id="editor"></textarea>
<script>
$("#editor").kendoEditor({
    tools: ["pdf"],
    pdf: {
        keepPNG: true
    }
});
</script>

Specifies the keywords of the exported PDF file.

Default: null

<textarea id="editor"></textarea>
<script>
    $("#editor").kendoEditor({
        tools: ["pdf"],
        pdf: {
            keywords: "Kendo UI Editor PDF export"
        }
    });
</script>

Set to true to reverse the paper dimensions if needed such that width is the larger edge.

Default: false

<textarea id="editor"></textarea>
<script>
    $("#editor").kendoEditor({
        tools: ["pdf"],
        pdf: {
            landscape: true
        }
    });
</script>

Specifies the margins of the page (numbers or strings with units). Supported units are "mm", "cm", "in" and "pt" (default).

<textarea id="editor"></textarea>
<script>
    $("#editor").kendoEditor({
        tools: ["pdf"],
        pdf: {
            margin: {
                bottom: 20,
                left: 20,
                right: 20,
                top: 20
            }
        }
    });
</script>

pdf.paperSize

String|Array

Specifies the paper size of the PDF document. The default "auto" means paper size is determined by content.

The size of the content in pixels will match the size of the output in points (1 pixel = 1/72 inch).

Supported values:

  • A predefined size: "A4", "A3" etc
  • An array of two numbers specifying the width and height in points (1pt = 1/72in)
  • An array of two strings specifying the width and height in units. Supported units are "mm", "cm", "in" and "pt".

Default: "auto"

<textarea id="editor"></textarea>
<script>
    $("#editor").kendoEditor({
        tools: ["pdf"],
        pdf: {
            paperSize : "A4"
        }
    });
</script>

A name or keyword indicating where to display the document returned from the proxy.

If you want to display the document in a new window or iframe, the proxy should set the "Content-Disposition" header to inline; filename="<fileName.pdf>".

Default: "_self"

<textarea id="editor"></textarea>
<script>
    $("#editor").kendoEditor({
        tools: ["pdf"],
        pdf: {
            forceProxy: true,
            proxyURL: "/save",
            proxyTarget: "_blank"
        }
    });
</script>

The URL of the server side proxy which will stream the file to the end user.

A proxy will be used when the browser is not capable of saving files locally, for example, Internet Explorer 9 and Safari.

The developer is responsible for implementing the server-side proxy.

The proxy will receive a POST request with the following parameters in the request body:

  • contentType: The MIME type of the file
  • base64: The base-64 encoded file content
  • fileName: The file name, as requested by the caller.

The proxy should return the decoded file with the "Content-Disposition" header set to attachment; filename="<fileName.pdf>".

Default: null

<textarea id="editor"></textarea>
<script>
    $("#editor").kendoEditor({
        tools: ["pdf"],
        pdf: {
            proxyURL: "/save"
        }
    });
</script>

Sets the subject of the PDF file.

Default: null

<textarea id="editor"></textarea>
<script>
    $("#editor").kendoEditor({
        tools: ["pdf"],
        pdf:{
            subject : "Kendo UI Editor overview"
        }
    });
</script>

pdf.title

String

Sets the title of the PDF file.

Default: null

<textarea id="editor"></textarea>
<script>
    $("#editor").kendoEditor({
        tools: ["pdf"],
        pdf: {
            title : "Overview"
        }
    });
</script>