JSON API - replaceVariableByHTML

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

replaceVariableByHTML

PREMIUM

TRIAL / ADVANCED

Replaces a single variable by HTML.

Note

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

JSON data

{
    "variable": "string",
    "type": "string",
    "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,
        "stylesReplacementType": "string",
        "stylesReplacementTypeIgnore": object,
        "stylesReplacementTypeOverwrite": boolean,
        "target": "string",
        "useHTMLExtended": boolean,
        "wordStyles": object
    }
}

Key	Description
variable	The template variable to be replaced by the HTML content.
type	Replacement type: block (default) or inline.
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).
stylesReplacementType	Empty as default. usePlaceholderStyles: keeps placeholder styles, styles from the imported HTML are ignored. Applies to the following styles: pPr, rPr. mixPlaceholderStyles: mixes placeholder styles, placeholder styles overwrite HTML styles with the same name. Applies to the following styles: pPr, rPr.
stylesReplacementTypeIgnore	Styles to be ignored from the imported HTML. Use with mixPlaceholderStyles. Empty as default.
stylesReplacementTypeOverwrite	If true, HTML styles overwrite placeholder styles with the same name that are not set in the stylesReplacementTypeIgnore option. Use with mixPlaceholderStyles. Default as false. Only available in Premium licenses.
target	Possible values are: document (default), header, footer, footnote, endnote, comment. This option sets the scope of the replacement procedure.
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

{
    "template": "template.docx",
    "actions": [
        {
            "action": "replaceVariableByHTML",
            "data": {
                "variable": "ADDRESS",
                "type": "inline",
                "html": "<p style=\"font-family: verdana; font-size: 11px\">phpdocx by <b>NarceaLabs</b></p>"
            }
        },
        {
            "action": "replaceVariableByHTML",
            "data": {
                "variable": "CHUNK_1",
                "type": "block",
                "html": "<style>strong {color: #ea5a28;}</style><div><div><p>At NarceaLabs we specialize in <strong>Rich Internet Applications</strong>. We cover the entire life process of any project, from web and <strong>graphic design</strong>, respecting the corporative image of each company, to content and text edition and <strong>multimedia</strong>, creating <strong>e-learning</strong> courses, <strong>system management</strong> and <strong>consulting</strong> on the final and operative site.</p><p>We work with \"scripting\" languages (PHP, JSP and ASP), <strong>databases</strong> (MySQL, PostgreSQL and Oracle) and <strong>operating systems</strong> (Linux, Windows Server). We design <strong>interfaces</strong> (Front-end and Back-end) in HTML5 with multiple integrations: Google Maps, Web Services, Multimedia Flash, QuickTime Video, and so on...</p><p>We have several <strong>web servers</strong> available in Spain (Hostalia), UK (RackSpace), and USA (Amazon and Google) high performance and high volume transfer.</p><p>Our team is specialist in every project step. We are:</p><div class=\"cube-line mbt mt\"><ul><li><strong>Programmers</strong>, experts in web development and software, mash-ups and data management.</li><li><strong>Designers</strong>, able to give shape and color to a project vision and mission.</li><li><strong>System administrators</strong>, in charge of efficiently manage the performance and safety of a project.</li><li><strong>Content managers</strong>, versed in composing and updating data and words of a website.</li><li><strong>Analysts</strong>, trained in management, positioning, IT, and other consulting fields.</li></ul></div><p></p><p>At NarceaLabs we are committed to producing an effective, efficient and high quality development. Our priorities are: <strong>usability, accessibility, indexability and updating</strong>, because every website is a living project.</p></div></div>"
            }
        },
        {
            "action": "replaceVariableByHTML",
            "data": {
                "variable": "CHUNK_2",
                "type": "block",
                "html": "<h1 style=\"color: #b70000\">An embedHTML() example</h1><p>We draw a table with border and rawspans and colspans:</p><table border=\"1\" style=\"border-collapse: collapse\" width=\"200\"><tbody><tr><td style=\"background-color: yellow\">1_1</td><td rowspan=\"3\" colspan=\"2\">1_2</td></tr><tr><td>Some random text.</td></tr><tr><td><ul><li>One</li><li>Two <b>and a half</b></li></ul></td></tr><tr><td>3_2</td><td>3_3</td><td>3_3</td></tr></tbody></table>"
            }
        }
    ]
}

A template can be a local file, a Base64 string, or a remote file.

Release notes

phpdocx 18.0:
- new action.