Read or add hyperlink to Excel in C#, VB.NET, Java, C++, PHP

Hyperlinks

EasyXLS™ library allows you to export Excel files with hyperlinks. The hyperlink is placed on a cell range.

There are four types of hyperlinks:

- Hyperlink to an URL
- Hyperlink to a file
- Hyperlink to a UNC
- Hyperlink to a cell from a sheet

The hyperlink also includes description, text mark and tool tip. A text mark is a link inside the file.

The component also allows reading hyperlinks from Excel files.

Source code sample
Export hyperlink to Excel file
Read hyperlink from Excel file

Source code sample

The below example shows how to export an Excel file with hyperlinks on a cell or cell ranges.


// Create an instance of the class that exports Excel files, having two sheets
ExcelDocument workbook = new ExcelDocument(2);

// Set the sheet names
ExcelWorksheet xlsTab1 = (ExcelWorksheet) workbook.easy_getSheetAt(0);
ExcelWorksheet xlsTab2 = (ExcelWorksheet) workbook.easy_getSheetAt(1);
xlsTab1.setSheetName("First tab");
xlsTab2.setSheetName("Second tab");

// Create hyperlink to URL
xlsTab1.easy_addHyperlink(EasyXLS.Constants.HyperlinkType.URL, 
        "https://www.easyxls.com", "Link to URL", "B2:E2");
  
// Create hyperlink to file
xlsTab1.easy_addHyperlink(EasyXLS.Constants.HyperlinkType.FILE, 
        "c:\\myfile.xlsx", "Link to file", "B3");
  
// Create hyperlink to UNC
xlsTab1.easy_addHyperlink(EasyXLS.Constants.HyperlinkType.UNC, 
        "\\\\computerName\\Folder\\file.txt", "Link to UNC", "B4:D4");
  
// Create hyperlink to second sheet
xlsTab1.easy_addHyperlink(EasyXLS.Constants.HyperlinkType.CELL, 
        "'Second tab'!D3", "Link to CELL", "B5");
  
// Create a name on the second sheet
xlsTab2.easy_addName("Name", "=Second tab!$A$1:$A$4");
  
// Create hyperlink to name
xlsTab1.easy_addHyperlink(EasyXLS.Constants.HyperlinkType.CELL, 
        "Name", "Link to a name", "B6");

// Export Excel file
workbook.easy_WriteXLSXFile("C:\\Samples\\Excel hyperlinks.xlsx");

Click here to see Continuous Code Listing

C++

// Create an instance of the class that exports Excel files
EasyXLS::IExcelDocumentPtr workbook;
hr = CoCreateInstance(__uuidof(EasyXLS::ExcelDocument),
		      NULL,
		      CLSCTX_ALL,
		      __uuidof(EasyXLS::IExcelDocument),
		      (void**) &workbook) ;

if(SUCCEEDED(hr)){

// Create two sheets
workbook->easy_addWorksheet_2("First tab");
workbook->easy_addWorksheet_2("Second tab");

EasyXLS::IExcelWorksheetPtr xlsTab1 = 
        (EasyXLS::IExcelWorksheetPtr)workbook->easy_getSheetAt(0);	
EasyXLS::IExcelWorksheetPtr xlsTab2 = 
        (EasyXLS::IExcelWorksheetPtr)workbook->easy_getSheetAt(1);	

// Create hyperlink to URL
xlsTab1->easy_addHyperlink_3(HYPERLINKTYPE_URL, 
        "https://www.easyxls.com", "Link to URL", "B2:E2");

// Create hyperlink to file
xlsTab1->easy_addHyperlink_3(HYPERLINKTYPE_FILE, 
        "c:\\myfile.xlsx", "Link to file", "B3");

// Create hyperlink to UNC
xlsTab1->easy_addHyperlink_3(HYPERLINKTYPE_UNC, 
        "\\\\computerName\\Folder\\file.txt", "Link to UNC", "B4:D4");

// Create hyperlink to second sheet
xlsTab1->easy_addHyperlink_3(HYPERLINKTYPE_CELL, 
        "'Second tab'!D3", "Link to CELL", "B5");

// Create a name on the second sheet
xlsTab2->easy_addName_2("Name", "=Second tab!$A$1:$A$4");

// Create hyperlink to name
xlsTab1->easy_addHyperlink_3(HYPERLINKTYPE_CELL, "Name", "Link to a name", "B6");

// Export Excel file
workbook->easy_WriteXLSXFile("C:\\Samples\\Excel hyperlinks.xlsx");

Click here to see Continuous Code Listing


C++.NET

// Create an instance of the class that exports Excel files, having two sheets
ExcelDocument ^workbook = gcnew ExcelDocument(2);

// Set the sheet names
ExcelWorksheet ^xlsTab1 = safe_cast<ExcelWorksheet^>(workbook->easy_getSheetAt(0));
ExcelWorksheet ^xlsTab2 = safe_cast<ExcelWorksheet^>(workbook->easy_getSheetAt(1));
xlsTab1->setSheetName("First tab");
xlsTab2->setSheetName("Second tab");

// Create hyperlink to URL
xlsTab1->easy_addHyperlink(EasyXLS::Constants::HyperlinkType::URL, 
        "https://www.easyxls.com", "Link to URL", "B2:E2");

// Create hyperlink to file
xlsTab1->easy_addHyperlink(EasyXLS::Constants::HyperlinkType::FILE, 
        "c:\\myfile.xlsx", "Link to file", "B3");

// Create hyperlink to UNC
xlsTab1->easy_addHyperlink(EasyXLS::Constants::HyperlinkType::UNC, 
        "\\\\computerName\\Folder\\file.txt", "Link to UNC", "B4:D4");

// Create hyperlink to second sheet
xlsTab1->easy_addHyperlink(EasyXLS::Constants::HyperlinkType::CELL, 
        "'Second tab'!D3", "Link to CELL", "B5");

// Create a name on the second sheet
xlsTab2->easy_addName("Name", "=Second tab!$A$1:$A$4");

// Create hyperlink to name
xlsTab1->easy_addHyperlink(EasyXLS::Constants::HyperlinkType::CELL, 
        "Name", "Link to a name", "B6");

// Export Excel file
workbook->easy_WriteXLSXFile("C:\\Samples\\Excel hyperlinks.xlsx");

Click here to see Continuous Code Listing

COM+:

// Create an instance of the class that exports Excel files
$workbook = new COM("EasyXLS.ExcelDocument");

// Create two sheets
$workbook->easy_addWorksheet_2("First tab");
$workbook->easy_addWorksheet_2("Second tab");

$xlsTab1 = $workbook->easy_getSheetAt(0);
$xlsTab2 = $workbook->easy_getSheetAt(1);

// Create hyperlink to URL
$xlsTab1->easy_addHyperlink_3($HYPERLINKTYPE_URL, 
        "https://www.easyxls.com", "Link to URL", "B2:E2");

// Create hyperlink to file
$xlsTab1->easy_addHyperlink_3($HYPERLINKTYPE_FILE, 
        "c:\\myfile.xlsx", "Link to file", "B3");

// Create hyperlink to UNC
$xlsTab1->easy_addHyperlink_3($HYPERLINKTYPE_UNC, 
        "\\\\computerName\\Folder\\file.txt", "Link to UNC", "B4:D4");

// Create hyperlink to second sheet
$xlsTab1->easy_addHyperlink_3($HYPERLINKTYPE_CELL, 
        "'Second tab'!D3", "Link to CELL", "B5");

// Create a name on the second sheet
$xlsTab2->easy_addName_2("Name", "=Second tab!\$A\$1:\$A\$4");

// Create hyperlink to name
$xlsTab1->easy_addHyperlink_3($HYPERLINKTYPE_CELL, "Name", "Link to a name", "B6");

// Export Excel file
$workbook->easy_WriteXLSXFile("C:\Samples\Excel hyperlinks.xlsx");

Click here to see Continuous Code Listing


Java:

// Create an instance of the class that exports Excel files
$workbook = new java("EasyXLS.ExcelDocument");
	
// Create two sheets
$workbook->easy_addWorksheet("First tab");
$workbook->easy_addWorksheet("Second tab");
	
$xlsTab1 = $workbook->easy_getSheetAt(0);
$xlsTab2 = $workbook->easy_getSheetAt(1);
	
// Create hyperlink to URL
$xlsTab1->easy_addHyperlink($HYPERLINKTYPE_URL, "https://www.easyxls.com", "Link to URL", "B2:E2");

// Create hyperlink to file
$xlsTab1->easy_addHyperlink($HYPERLINKTYPE_FILE, "c:\\myfile.xls", "Link to file", "B3");

// Create hyperlink to UNC
$xlsTab1->easy_addHyperlink($HYPERLINKTYPE_UNC, "\\\\computerName\\Folder\\file.txt",
                                                "Link to UNC", "B4:D4");

// Create hyperlink to cell on second sheet
$xlsTab1->easy_addHyperlink($HYPERLINKTYPE_CELL, "'Second tab'!D3", "Link to CELL", "B5");

// Create a name on the second sheet
$xlsTab2->easy_addName("Name", "=Second tab!\$A\$1:\$A\$4");
	
// Create hyperlink to name
$xlsTab1->easy_addHyperlink($HYPERLINKTYPE_CELL, "Name", "Link to a name", "B6");

// Export Excel file
$workbook->easy_WriteXLSXFile("C:\Samples\Excel hyperlinks.xlsx");

Click here to see Continuous Code Listing

.NET:

# Create an instance of the class that exports Excel files having two sheets
workbook = ExcelDocument(2)

# Set the sheet names
xlsTab1 = workbook.easy_getSheetAt(0)
xlsTab2 = workbook.easy_getSheetAt(1)
xlsTab1.setSheetName("First tab")
xlsTab2.setSheetName("Second tab")

# Create hyperlink to URL
xlsTab1.easy_addHyperlink(HyperlinkType.URL, "https://www.easyxls.com", "Link to URL", "B2:E2")

# Create hyperlink to file
xlsTab1.easy_addHyperlink(HyperlinkType.FILE, "c:\\myfile.xls", "Link to file", "B3")

# Create hyperlink to UNC
xlsTab1.easy_addHyperlink(HyperlinkType.UNC, "\\\\computerName\\Folder\\file.txt", "Link to UNC", "B4:D4")

# Create hyperlink to cell on second sheet
xlsTab1.easy_addHyperlink(HyperlinkType.CELL, "'Second tab'!D3", "Link to CELL", "B5")

# Create a name on the second sheet
xlsTab2.easy_addName("Name", "=Second tab!$A$1:$A$4")

# Create hyperlink to name
xlsTab1.easy_addHyperlink(HyperlinkType.CELL, "Name", "Link to a name", "B6")

# Export Excel file
workbook.easy_WriteXLSXFile("C:\\Samples\\Excel hyperlinks.xlsx")

Click here to see Continuous Code Listing


Java:

# Create an instance of the class that exports Excel files having two sheets
workbook = gateway.jvm.ExcelDocument(2)

# Set the sheet names
xlsTab1 = workbook.easy_getSheetAt(0)
xlsTab2 = workbook.easy_getSheetAt(1)
xlsTab1.setSheetName("First tab")
xlsTab2.setSheetName("Second tab")

# Create hyperlink to URL
xlsTab1.easy_addHyperlink(gateway.jvm.HyperlinkType.URL, "https://www.easyxls.com", 
                          "Link to URL", "B2:E2")

# Create hyperlink to file
xlsTab1.easy_addHyperlink(gateway.jvm.HyperlinkType.FILE, "c:\\myfile.xls", "Link to file", "B3")

# Create hyperlink to UNC
xlsTab1.easy_addHyperlink(gateway.jvm.HyperlinkType.UNC, "\\\\computerName\\Folder\\file.txt", 
                          "Link to UNC", "B4:D4")

# Create hyperlink to cell on second sheet
xlsTab1.easy_addHyperlink(gateway.jvm.HyperlinkType.CELL, "'Second tab'!D3", "Link to CELL", "B5")

# Create a name on the second sheet
xlsTab2.easy_addName("Name", "=Second tab!$A$1:$A$4")

# Create hyperlink to name
xlsTab1.easy_addHyperlink(gateway.jvm.HyperlinkType.CELL, "Name", "Link to a name", "B6")

# Export Excel file
workbook.easy_WriteXLSXFile("C:\\Samples\\Excel hyperlinks.xlsx")

Click here to see Continuous Code Listing

The screen shot provides an example of an Excel file with hyperlinks to URL, file, UNC, another sheet and name.

Export hyperlink to Excel file

EasyXLS allows you to export Excel files with hyperlinks using ExcelWorksheet.easy_addHyperlink method. The above code sample shows how to achieve this goal.

Read hyperlink from Excel file

EasyXLS allows you to read hyperlinks from Excel file using ExcelWorksheet.easy_getHyperlinkAt method. The Excel file must be imported first and after that the hyperlinks are available on each sheet.

Available for: Professional, Excel Writer, Excel Reader

EasyXLS Excel libraries:
.NET Excel Library
full .NET version to import, export or convert Excel files
COM+ Excel Library
full COM+ version to import, export or convert Excel files


Java Excel Library
full Java version to import, export or convert Excel files

File formats:
Office 365 MS Excel 2021 - 2025 MS Excel 2007 - 2019 MS Excel 97 - 2003

Hyperlinks

Table of contents

Source code sample

Export hyperlink to Excel file

Read hyperlink from Excel file

Related methods:

Related constants:

EasyXLS Excel libraries:

File formats: