Use the Excel Export API to Add a Hyperlink to a Picture

  • 2 minutes to read

This example demonstrates how to associate a hyperlink with a picture. Such hyperlinks are represented by the XlPictureHyperlink objects, which inherit basic hyperlink properties from the XlHyperlinkBase class.

To add a hyperlink to a picture, do the following.

  1. Create a picture to which the hyperlink should be attached.
  2. Access the XlPictureHyperlink object from the IXlPicture.HyperlinkClick property.
  3. Use the XlPictureHyperlink object’s XlHyperlinkBase.TargetUri property to specify the destination to which the hyperlink should refer.
  4. Add a tooltip to your hyperlink, if required. To do this, assign the tooltip text to the XlHyperlinkBase.Tooltip property. This text will be displayed when the cursor hovers over the picture.
// Create an exporter instance.
IXlExporter exporter = XlExport.CreateExporter(documentFormat);

// Create a new document.
using (IXlDocument document = exporter.CreateDocument(stream))
{
    document.Options.Culture = CultureInfo.CurrentCulture;

    // Create a worksheet.
    using (IXlSheet sheet = document.CreateSheet())
    {

        // Load a picture from a file and add a hyperlink to it.
        using (IXlPicture picture = sheet.CreatePicture())
        {
            picture.Image = Image.FromFile(Path.Combine(imagesPath, "DevExpress.png"));
            picture.HyperlinkClick.TargetUri = "https://www.devexpress.com/";
            picture.HyperlinkClick.Tooltip = "Developer Express Inc.";
            picture.SetTwoCellAnchor(new XlAnchorPoint(1, 1, 0, 0), new XlAnchorPoint(10, 5, 2, 15), XlAnchorType.TwoCell);
        }
    }
}