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

Inserts a picture from a file at the set location and resizes it to the specified dimensions. Allows you to lock the aspect ratio.

Namespace : DevExpress.Spreadsheet

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

NuGet Package : DevExpress.Spreadsheet.Core

csharp

[Browsable(false)]
Picture AddPicture(
    Image image,
    float x,
    float y,
    float width,
    float height,
    bool lockAspectRatio
)

<Browsable(False)>
Function AddPicture(
    image As Image,
    x As Single,
    y As Single,
    width As Single,
    height As Single,
    lockAspectRatio As Boolean
) As Picture

Parameters

Name	Type	Description
image	Image

The image to insert.

| | x | Single |

The distance from the left of the worksheet. The ISpreadsheetComponent.Unit property specifies the unit of measurement.

| | y | Single |

The distance from the top of the worksheet. The ISpreadsheetComponent.Unit property specifies the unit of measurement.

| | width | Single |

The width of the picture. The ISpreadsheetComponent.Unit property specifies the unit of measurement.

| | height | Single |

The 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

The inserted picture.

Remarks

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.

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