feat: insert hyperlink in paragraph

[emadyounan]

Good evening,

I have two document files and I need to make the first document file hyperlink to the other one from the text I extracted from the table cell

wordDoc = Document(r'testfile.docx')

for table in wordDoc.tables:
    for row in table.rows:
        for cell in row.cells:
            if cell.text == "page" or cell.text == "subject":
                pass
            else:
                if cell.text.isdigit():
                   # i need to add hyperlink to this cell text to that file
                   # cell text will be like 3
                    add_hyperlink(cell.text, "test2.docx#3")
                    wordDoc.save('demo.docx')

[scanny]

Not at present, but this is an interesting use-case. A couple of the challenges I can see off the top of my head would be:

• identifying the text in the paragraph you wanted to turn into a hyperlink. I suppose this would be with start and stop indices.
• isolating the text into its own run.
• inserting the hyperlink element at the correct (start) position and moving the text run down into the hyperlink element as a child.

I'm going to make this a feature request, but if I wanted it myself I'd be looking at how to do it with the underlying lxml objects, writing a function something like:

def insert_hyperlink(
    paragraph: Paragraph, address: str, start: int, stop: Optional[int] = None, text: Optional[str] = None
) -> Hyperlink:
    """Insert Hyperlink object at position `start` in `paragraph`.

    When `stop` is provided, the text between start and stop is made the text of the hyperlink. When `text` is
    provided, it becomes the text of the hyperlink. If both `stop` and `text` are provided, `text` is appended
    to the text between start and stop.

    The hyperlink text is placed into a single run formatted with the built-in `Hyperlink` character-style.
    ```
    ...