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


Returns a workbook picture index at position index in worksheet.

Component Version macOS Windows Linux Server iOS SDK
XL 3.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "XL.Sheet.GetPicture"; bookRef; sheetIndex; Index; Selector )   More


Parameter Description Example
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
Index The image index from 0 to XL.Sheet.PictureCount-1. $index
Selector Which value to return. Can be id, rowTop, colLeft, rowBottom, colRight, width, height, offsetx or offsety. "id"


Returns value or error.


Returns a workbook picture index at position index in worksheet.
Output parameters:
(rowTop, colLeft) - top left position of picture;
(rowBottom, colRight) - bottom right position of picture;
width - width of picture in pixels;
height - height of picture in pixels;
offsetX - horizontal offset of picture in pixels;
offsetY - vertical offset of picture in pixels.
Use XL.Book.GetPicture for extracting binary data of picture by workbook picture index.

See also

This function checks for a license.

Created 18th August 2014, last changed 17th October 2017

XL.Sheet.GetPaper - XL.Sheet.GetPrintArea