Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

XL.Sheet.SetPictureWithScale

Sets a picture with pictureId identifier at position row and col with scale factor and offsets in pixels.

Component Version macOS Windows Linux Server iOS SDK
XL 3.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "XL.Sheet.SetPictureWithScale"; bookRef; sheetIndex; Row; Column; pictureId; scale { ; X; Y; pos } )   More

Parameters

Parameter Description Example Flags
bookRef The reference to the workbook. Please use XL.LoadBook to load a file. $ref
sheetIndex The index of the sheet. This number ranges from 0 to XL.Book.SheetCount-1. 0
Row The row for the cell. First row has index 0. $row
Column The column for the cell. First column has index 0. $column
pictureId The picture identifier number. $pictureID
scale The scale factor. 1.0
X Relative offset. 0 Optional
Y Relative offset. 0 Optional
pos The positioning. 0 = Move and Size, 1 = Move, 2 = Absolute. 0 Optional

Result

Returns OK or error.

Description

Sets a picture with pictureId identifier at position row and col with scale factor and offsets in pixels.
Use XL.Book.AddPictureFile or XL.Book.AddPictureContainer for getting picture identifier.

scale = 0 means the picture is stretched inside the specified cell or merged area.

Examples

Add a picture to excel sheet:

# add picture to file
Set Variable [$logoID; Value:MBS( "XL.Book.AddPictureContainer"; $book; Writing data::Logo)]
# position with size:
Set Variable [$r; Value:MBS( "XL.Sheet.SetPictureWithSize"; $book; $sheet; 2; 1; $logoID; 100; 100)]
# or with factor:
Set Variable [$r; Value:MBS( "XL.Sheet.SetPictureWithScale"; $book; $sheet; 2; 1; $logoID; .2)]

See also

Example Databases

This function checks for a license.

Created 18th August 2014, last changed 6th June 2024


XL.Sheet.SetPaper - XL.Sheet.SetPictureWithSize