PictureCollection.AddPicture(Image, CellRange, Boolean) Method

Inserts an image that fits into the specified range. Allows you to lock the aspect ratio.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

[Browsable(false)]
Picture AddPicture(
    Image image,
    CellRange targetRange,
    bool lockAspectRatio
)

VB.NET

<Browsable(False)>
Function AddPicture(
    image As Image,
    targetRange As CellRange,
    lockAspectRatio As Boolean
) As Picture

Parameters

Name	Type	Description
image	Image	A Image object that is the image to insert.
targetRange	CellRange	A CellRange to which the inserted picture fits.
lockAspectRatio	Boolean	true to lock the aspect ratio; otherwise,false.

Returns

Type	Description
Picture	A Picture object that is the inserted picture.

Remarks

The image is resized to fit in the specified range.

The inserted picture has FloatingObject.Placement set to Placement.MoveAndSize.

Use the PictureCollection.AddPicture(SpreadsheetImageSource, CellRange, Boolean) overload instead of this overload on non-Windows environments.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AddPicture(Image, CellRange, 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#

web-dashboard-custom-info-exported-excel/CS/WebDashboardForm.aspx.cs#L39

sheet.Rows.Insert(0, 3);
sheet.Pictures.AddPicture(Properties.Resources.dxLogo, sheet.Range.FromLTRB(0, 0, 5, 2), true);
Cell textCell = sheet.Cells[0, 5];

VB.NET

web-dashboard-custom-info-exported-excel/VB/WebDashboardForm.aspx.vb#L42

sheet.Rows.Insert(0, 3)
sheet.Pictures.AddPicture(Properties.Resources.dxLogo, sheet.Range.FromLTRB(0, 0, 5, 2), True)
Dim textCell As Cell = sheet.Cells(0, 5)

winforms-dashboard-customize-exported-document/VB/CustomExportDocumentExample/Form1.vb#L48

sheet.Rows.Insert(0, 3)
sheet.Pictures.AddPicture(My.Resources.dxLogo, sheet.Range.FromLTRB(0, 0, 5, 2), True)
Dim textCell As Cell = sheet.Cells(0, 5)