ShapeHyperlink Interface

A hyperlink associated with a drawing object.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

public interface ShapeHyperlink :
    HyperlinkBase

VB.NET

Public Interface ShapeHyperlink
    Inherits HyperlinkBase

Related API Members

The following members return ShapeHyperlink objects:

• Shape.Hyperlink
• Shape.InsertHyperlink(String, Boolean)

Remarks

A ShapeHyperlink object for a particular Shape is accessible by using the Shape.Hyperlink property. To associate a hyperlink with a drawing object, use the Shape.InsertHyperlink method. To delete a hyperlink, use the Shape.RemoveHyperlink method.

The following code snippet illustrates how to add a hyperlink to a picture.

View Example

PictureActions.vb

' Set the measurement unit to Millimeter.
workbook.Unit = DevExpress.Office.DocumentUnit.Millimeter
workbook.Worksheets.ActiveWorksheet.DefaultRowHeight = 20
workbook.Worksheets.ActiveWorksheet.DefaultColumnWidth = 20

workbook.BeginUpdate()
Try
    Dim worksheet As Worksheet = workbook.Worksheets(0)
    ' Insert pictures.
    Dim pic As Picture = worksheet.Pictures.AddPicture("Pictures\x-spreadsheet.png", worksheet.Cells("A1"))
    worksheet.Pictures.AddPicture("Pictures\x-spreadsheet.png", worksheet.Cells("A1"))
    ' Specify picture name.
    pic.Name = "Logo"
    pic.AlternativeText = "Spreadsheet logo"
    ' Move a picture.
    pic.Move(30, 50)
    ' Move and size the picture with underlying cells. 
    pic.Placement = Placement.MoveAndSize
    worksheet.Rows(1).Height += 20
    worksheet.Columns("D").Width += 20
    ' Move another picture to illustrate OffsetX, OffsetY properties.
    worksheet.Pictures(1).Move(pic.OffsetY, pic.OffsetX)
Finally
    workbook.EndUpdate()
End Try

PictureActions.cs

// Set the measurement unit to Millimeter.
workbook.Unit = DevExpress.Office.DocumentUnit.Millimeter;
workbook.Worksheets.ActiveWorksheet.DefaultRowHeight = 20;
workbook.Worksheets.ActiveWorksheet.DefaultColumnWidth = 20;

workbook.BeginUpdate();
try
{
    Worksheet worksheet = workbook.Worksheets[0];
    // Insert pictures.
    Picture pic = worksheet.Pictures.AddPicture("Pictures\\x-spreadsheet.png", worksheet.Cells["A1"]);
    worksheet.Pictures.AddPicture("Pictures\\x-spreadsheet.png", worksheet.Cells["A1"]);
    // Specify picture name.
    pic.Name = "Logo";
    pic.AlternativeText = "Spreadsheet logo";
    // Move a picture.
    pic.Move(30, 50);
    // Move and size the picture with underlying cells. 
    pic.Placement = Placement.MoveAndSize;
    worksheet.Rows[1].Height += 20;
    worksheet.Columns["D"].Width += 20;
    // Move another picture to illustrate OffsetX, OffsetY properties.
    worksheet.Pictures[1].Move(pic.OffsetY, pic.OffsetX);
}
finally
{
    workbook.EndUpdate();
}