PictureCollection.AddPicture(SpreadsheetImageSource, Single, Single, Single, Single, Boolean) Method

Inserts a picture from the SpreadsheetImageSource object at the specified location and resize it to the specified dimensions allowing you to lock the aspect ratio.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

Picture AddPicture(
    SpreadsheetImageSource imageSource,
    float x,
    float y,
    float width,
    float height,
    bool lockAspectRatio
)

VB.NET

Function AddPicture(
    imageSource As SpreadsheetImageSource,
    x As Single,
    y As Single,
    width As Single,
    height As Single,
    lockAspectRatio As Boolean
) As Picture

Parameters

Name	Type	Description
imageSource	SpreadsheetImageSource	A SpreadsheetImageSource object containing an image to insert.
x	Single	A Single value that is the distance from the left of the worksheet. The ISpreadsheetComponent.Unit property specifies the unit of measurement.
y	Single	A Single value that is the distance from the top of the worksheet. The ISpreadsheetComponent.Unit property specifies the unit of measurement.
width	Single	A Single value that is the desired width of the picture. The ISpreadsheetComponent.Unit property specifies the unit of measurement.
height	Single	A Single value that is the desired height of the picture. The ISpreadsheetComponent.Unit property specifies the unit of measurement.
lockAspectRatio	Boolean	true, to lock the aspect ratio; otherwise, false.

Returns

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

Remarks

The SpreadsheetImageSource object enables you to create a picture from various sources - from a stream, a file, or from a Image object.

The image below illustrates the distances used to specify a picture’s placement on a worksheet.

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

Related GitHub Examples

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

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

// and resize it to a width of 70 mm and a height of 20 mm, locking the aspect ratio.
worksheet.Pictures.AddPicture(imageSource, 120, 80, 70, 20, true);
// Insert the picture to be removed.

VB.NET

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

' and resize it to a width of 70 mm and a height of 20 mm, locking the aspect ratio.
worksheet.Pictures.AddPicture(imageSource, 120, 80, 70, 20, True)
' Insert the picture to be removed.

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

' and resize it to a width of 70 mm and a height of 20 mm, locking the aspect ratio.
worksheet.Pictures.AddPicture(imageSource, 120, 80, 70, 20, True)
' Insert the picture to be removed.