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

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

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

Picture AddPicture(
    string filename,
    float x,
    float y,
    float width,
    float height,
    bool lockAspectRatio
)

VB.NET

Function AddPicture(
    filename As String,
    x As Single,
    y As Single,
    width As Single,
    height As Single,
    lockAspectRatio As Boolean
) As Picture

Parameters

Name	Type	Description
filename	String	A string that specifies a path to the image file.
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 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 snippet (auto-collected from DevExpress Examples) contains a reference to the AddPicture(String, 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#

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

// resize it to a width of 85 mm and a height of 25 mm, and lock the aspect ratio.
worksheet.Pictures.AddPicture("Pictures\\x-docserver.png", 70, 40, 85, 25, true);
// Insert a picture.

VB.NET

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

' resize it to a width of 85 mm and a height of 25 mm, and lock the aspect ratio.
worksheet.Pictures.AddPicture("Pictures\x-docserver.png", 70, 40, 85, 25, True)
' Insert a picture.