Shape.InsertHyperlink(String, Boolean) Method

Associates a hyperlink with the drawing object.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v23.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

ShapeHyperlink InsertHyperlink(
    string uri,
    bool isExternal
)

VB.NET

Function InsertHyperlink(
    uri As String,
    isExternal As Boolean
) As ShapeHyperlink

Parameters

Name	Type	Description
uri	String	A string that is the URI of the hyperlink.
isExternal	Boolean	true, if the hyperlink points to external location; otherwise, false.

Returns

Type	Description
ShapeHyperlink	A ShapeHyperlink object that is a hyperlink associated with the drawing object in a worksheet.

Example

View Example

PictureActions.vb

workbook.BeginUpdate()
Try
    Dim worksheet As Worksheet = workbook.Worksheets(0)
    ' Insert picture.
    Dim pic As Picture = worksheet.Pictures.AddPicture("Pictures\x-docserver.png", worksheet.Cells("A1"))
    ' Add a hyperlink.
    pic.InsertHyperlink("https://www.devexpress.com/products/net/office-file-api/", True)
Finally
    workbook.EndUpdate()
End Try

PictureActions.cs

workbook.BeginUpdate();
try
{
    Worksheet worksheet = workbook.Worksheets[0];
    // Insert picture.
    Picture pic = worksheet.Pictures.AddPicture("Pictures\\x-docserver.png", worksheet.Cells["A1"]);
    // Add a hyperlink.
    pic.InsertHyperlink("https://www.devexpress.com/products/net/office-file-api/", true);
}
finally
{
    workbook.EndUpdate();
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the InsertHyperlink(String, Boolean) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

spreadsheet-document-api-examples-part2/CS/SpreadsheetDocServerAPIPart2/CodeExamples/PictureActions.cs#L63

    // Add a hyperlink.
    pic.InsertHyperlink("https://www.devexpress.com/products/net/office-file-api/", true);
}

winforms-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_API_Part02/SpreadsheetActions/PictureActions.cs#L171

    // Add a hyperlink.
    pic.InsertHyperlink("http://www.devexpress.com/Products/NET/Document-Server/", true);
}

VB.NET

wpf-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/ShapeActions.vb#L99

' Add a hyperlink.
pic.InsertHyperlink("http://www.devexpress.com/", True)
worksheet.Shapes(1).InsertHyperlink("http://www.devexpress.com/Products/NET/Controls/WPF/", True)

spreadsheet-document-api-examples-part2/VB/SpreadsheetDocServerAPIPart2/CodeExamples/PictureActions.vb#L57

    ' Add a hyperlink.
    pic.InsertHyperlink("https://www.devexpress.com/products/net/office-file-api/", True)
Finally

winforms-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_API_Part02/SpreadsheetActions/PictureActions.vb#L152

    ' Add a hyperlink.
    pic.InsertHyperlink("http://www.devexpress.com/Products/NET/Document-Server/", True)
Finally