JSON API - addLink

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addLink

PREMIUM

TRIAL / ADVANCED

Inserts a link.

Note

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

JSON data

{
    "text": "string",
    "options": {
        "url": "string",
        "rStyle": "string",
        /* check addText styles */
    }
}

Styles from addText can be used.

Key	Description
text	Text content.
url	The url where the text should be linked or internal bookmark name (#bookmark_name).
rStyle	Sets a custom character style to the hyperlink (DefaultParagraphFontPHPDOCX is set as default).

Code samples

Example #1

{
    "actions": [
        {
            "action": "addLink",
            "data": {
                "text": "Link to Google",
                "options": {
                    "url": "https://www.google.com"
                }
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "And now the same link with some additional formatting:"
            }
        },
        {
            "action": "addLink",
            "data": {
                "text": "Link to Google in red color and not underlined",
                "options": {
                    "url": "https://www.google.com",
                    "color": "B70000",
                    "underline": "none"
                }
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.