JSON API - embedHTML

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

embedHTML

PREMIUM

TRIAL / ADVANCED

Inserts HTML content into a Word document.

Note

You are reading the JSON API documentation. For the PHP API method please go to embedHTML.

JSON data

{
    "html": "string",
    "options": {
        "addDefaultStyles": boolean,
        "addDefaultStylesPpr": boolean,
        "addDefaultStylesRpr": boolean,
        "baseURL": "string",
        "cssEntityDecode": boolean,
        "customListStyles": boolean,
        "disableWrapValue": boolean,
        "downloadImages": boolean,
        "embedFonts": boolean,
        "filter": "string",
        "forceNotTidy": boolean,
        "generateCustomListStyles": boolean,
        "parseAnchors": boolean,
        "parseCSSVars": boolean,
        "parseDivs": "string",
        "parseFloats": boolean,
        "removeLineBreaks": boolean,
        "strictWordStyles": boolean,
        "useHTMLExtended": boolean,
        "wordStyles": object
    }
}

Key	Description
html	The HTML code to be translated into WordML.
addDefaultStyles	True as default, if false prevents adding default styles when strictWordStyles is false.
addDefaultStylesPpr	True as default, if false prevents adding default pPr styles when strictWordStyles is false.
addDefaultStylesRpr	True as default, if false prevents adding default rPr styles when strictWordStyles is false.
baseURL	The base URL used to complete the relative paths of links and images.
cssEntityDecode	If true uses html_entity_decode to parse CSS, useful when using font families with non-ASCII names.
customListStyles	If true checks if there is a custom list style with that name and uses it.
disableWrapValue	If true disable using a wrap value with Tidy to prevent extra blank spaces. Default as false.
downloadImages	If true inserts the images into the docx document, otherwise just links them as an external source.
embedFonts	If true downloads and embeds TTF fonts from @font-face rules. False as default. Only available in Premium licenses.
filter	Only renders the filtered contents. It could be an string denoting an id ('#myId'), a class ('.myClass'), a HTML tag or a valid XPath expression ('//expression').
forceNotTidy	False as default. If true, avoid using Tidy. Only recommended if Tidy can't be installed.
generateCustomListStyles	If true generates automatically the custom list styles from the list styles (decimal, lower-alpha, lower-latin, lower-roman, upper-alpha, upper-latin, upper-roman).
parseAnchors	If true parses the anchors included in the HTML code.
parseCSSVars	If true parses CSS variables.
parseDivs	paragraph or table. By default the method parses the div elements as containers.
parseFloats	If true preserves the floating properties of images and tables.
removeLineBreaks	If true removes extra line breaks that can be generated when transforming HTML that includes strings without a parent tag.
strictWordStyles	If true ignores almost all CSS styles and uses the styles set via the wordStyles option (see next).
useHTMLExtended	If true allows using HTML Extended tags. False as default.
wordStyles	One may associate different Word styles to HTML classes, ids or tags.

Code samples

Example #1

{
    "actions": [
        {
            "action": "embedHTML",
            "data": {
                "html": "<h1 style=\"color: #b70000\">An embedHTML() example</h1><p>We draw a table with border and rowspans and colspans:</p><style>td {vertical-align: top;}</style><table border=\"1\" style=\"border-collapse: collapse\" width=\"500\"><tbody><tr><td style=\"background-color: yellow\" width=\"400\">1_1</td><td rowspan=\"3\" colspan=\"2\" width=\"100\">1_2</td></tr><tr><td width=\"500\">Some random text.</td></tr><tr><td width=\"500\"><ul><li>One</li><li>Two <b>and a half</b></li></ul></td></tr><tr><td width=\"400\">3_2</td><td width=\"50\">3_3</td><td width=\"50\">3_3</td></tr></tbody></table>"
            }
        }
    ]
}

Example #2

{
    "actions": [
        {
            "action": "embedHTML",
            "data": {
                "html": "<style>:root {--blue: #1990fa;font-weight: bold;}.varcolor {color: var(--blue);}.color {color: green;}</style><p class=\"varcolor\">Text with blue color using a CSS variable.</p><p class=\"color\">Text with a custom color.</p>",
                "options": {
                    "parseCSSVars": true
                }
            }
        },
        {
            "action": "embedHTML",
            "data": {
                "html": "<style>:root {--text-color: green;--myborders: dashed;--text-size: 4px;font-weight: bold;--color-r: red;--color-g: green;--sz-t1: 46px;--font-fc: Arial;}p {--background-cl: #decb97;border-bottom: var(--text-size) var(--myborders) var(--text-color);color: var(--color-r);font-size: var(--sz-t1, 32px);background-color: var(--background-cl);}span.c1 {color: var(--color-g);font-size: var(--sz-t2, 16px);font-family: var(--font-fc);}</style><p>Complex <span class=\"c1\">CSS variables</span> can be used.</p>",
                "options": {
                    "parseCSSVars": true
                }
            }
        }
    ]
}

Example #3

{
    "actions": [
        {
            "action": "embedHTML",
            "data": {
                "html": "<p>Text content</p>"
            }
        },
        {
            "action": "embedHTML",
            "data": {
                "html": "<phpdocx_bookmark data-type=\"start\" data-name=\"bookmark_name\" /><p>Text with a bookmark</p><phpdocx_bookmark data-type=\"end\" data-name=\"bookmark_name\" />",
                "options": {
                    "useHTMLExtended": true
                }
            }
        },
        {
            "action": "embedHTML",
            "data": {
                "html": "<phpdocx_break data-type=\"page\" data-number=\"2\" /><phpdocx_link data-text=\"My Link\" data-url=\"#bookmark_name\" /><p><span>More text content  Other content </span><phpdocx_link data-text=\"External link\" data-url=\"https://www.phpdocx.com\" /></p><phpdocx_break data-type=\"line\" data-number=\"5\" /><phpdocx_crossreference data-text=\"My cross-reference\" data-type=\"bookmark\" data-referenceName=\"bookmark_name\" /><p style=\"text-align: right;font-weight: bold;font-family: Arial;\"><phpdocx_dateandhour data-dateFormat=\"dd' of 'MMMM' of 'yyyy' at 'H:mm\"/></p>",
                "options": {
                    "useHTMLExtended": true
                }
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.