How to add a hyperlink to a table. [This is the answer!] #1041

Activity

1. NeilRiver commented on Jan 26, 2022

   

   NeilRiver

   on Jan 26, 2022

   Last edited by NeilRiver

   Author

   More actions

   if you wanna without spaces in first table

           paragraph = row_cells[0].paragraphs[0]
           add_hyperlink(paragraph, 'Link url', jira)
   
   

   👍React with 👍4Reacted by sixlycos, andrejpu, iglowacki and Bruno Thums
2. abubelinha commented on Mar 25, 2023

   

   abubelinha

   on Mar 25, 2023

   Last edited by abubelinha

   More actions

   Thanks. I tried the above code but it didn't work for me:

   • Wrongly indented code after this line?
     table = document.add_table(rows=1, cols=4, style='Table Grid')
     So I removed first indentation level in all lines below that one.
     But I guess there is some missing code where i and table_object should be defined,
     because I got a new error:
   • for jira, summary, priority, status in table_object[i]:
NameError: name 'table_object' is not defined
3. sixlycos commented on Apr 7, 2023

   

   sixlycos

   on Apr 7, 2023

   Last edited by sixlycos

   More actions

   @abubelinha hello there, I find this issue and use this way solved my problem.
   keypoint is use
   p_table = row_cells[0].add_paragraph()
   to add the cell which u want to add hyperlink.

   NeilRiver show the way but did not paste the complete code, you can check my code to solve your problem

   def add_hyperlink(paragraph, url, text, color, underline):
       # This gets access to the document.xml.rels file and gets a new relation id value
       part = paragraph.part
       r_id = part.relate_to(url, docx.opc.constants.RELATIONSHIP_TYPE.HYPERLINK, is_external=True)
       # Create the w:hyperlink tag and add needed values
       hyperlink = docx.oxml.shared.OxmlElement('w:hyperlink')
       hyperlink.set(docx.oxml.shared.qn('r:id'), r_id, )
       # Create a w:r element
       new_run = docx.oxml.shared.OxmlElement('w:r')
       # Create a new w:rPr element
       rPr = docx.oxml.shared.OxmlElement('w:rPr')
       # Add color if it is given
       if not color is None:
           c = docx.oxml.shared.OxmlElement('w:color')
           c.set(docx.oxml.shared.qn('w:val'), color)
           rPr.append(c)
       # Remove underlining if it is requested
       if not underline:
           u = docx.oxml.shared.OxmlElement('w:u')
           u.set(docx.oxml.shared.qn('w:val'), 'none')
           rPr.append(u)
       # Join all the xml elements together  add the required text to the w:r element
       new_run.append(rPr)
       new_run.text = text
       hyperlink.append(new_run)
       paragraph._p.append(hyperlink)
       return hyperlink
   
   Word = Document()
   
   test_url = 'http://github.com'
   
   records = (
       (3, '101', 'Spam'),
       (7, '422', 'Eggs'),
       (4, '631', 'Spam, spam, eggs, and spam')
   )
   
   table = Word.add_table(rows=1, cols=3)
   hdr_cells = table.rows[0].cells
   hdr_cells[0].text = 'Qty'
   hdr_cells[1].text = 'Id'
   hdr_cells[2].text = 'Desc'
   for qty, id, desc in records:
       row_cells = table.add_row().cells
       row_cells[0].text = str(qty)
       row_cells[1].text = id
       p_tag = row_cells[2].add_paragraph()
       hyperlink = add_hyperlink(p_tag, test_url, desc, '0000FF', False)
   
   Word.save('table_test_67.docx')
   

   👍React with 👍3Reacted by abubelinha, Bruno Thums and Axel François
4. abubelinha commented on Apr 23, 2023

   

   abubelinha

   on Apr 23, 2023

   Last edited by abubelinha

   More actions

   Thanks @sixlycos , it worked except for the underlining option:
   My links were never underlined, no matters if I pass underline=True or underline=False

   So I changed the if not underline code like this:

   	if underline:
   		u = docx.oxml.shared.OxmlElement('w:u')
   		u.set(docx.oxml.shared.qn('w:val'), 'single')
   		rPr.append(u)
   	else:
   		u = docx.oxml.shared.OxmlElement('w:u')
   		u.set(docx.oxml.shared.qn('w:val'), 'none')
   		rPr.append(u)

   More underlining style options are available in #19 and in this documentation
   (you need to use them changing 1st letter to lowercase: 'wave', 'double', 'dottedHeavy', and so on).

   @abubelinha

   👍React with 👍1Reacted by Bruno Thums
5. scanny

   added

   hyperlinkRead and write hyperlinks in paragraphRead and write hyperlinks in paragraph

   on Sep 28, 2023
6. pcraig3

   added a commit that references this issue on Dec 28, 2025

   Add a heading with a link

   ...

   fb34de9