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


Returns a picture at position index.

Component Version macOS Windows Linux Server iOS SDK
XL 3.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "XL.Book.GetPicture"; bookRef; index )   More


Parameter Description Example
bookRef The reference to the workbook. Please use XL.LoadBook to load a file. $ref
index The index of the picture from 0 to XL.Book.PictureCount-1. 0


Returns image or error.


Returns a picture at position index.
Returns container value with file, jpeg, tiff or png.
Please use XL.Book.GetPictureType to know the picture type before or Container.GetName and Container.GetTypes after.


Query picture of a cell:

Set Variable [ $sheet ; Value: 0 ]
Set Variable [ $row ; Value: 2 ]
Set Variable [ $col ; Value: 3 ]
Set Variable [ $index ; Value: MBS( "XL.Sheet.GetCellPicture"; $bookRef; $sheet; $row; $col) ]
Set Field [ XL::test ; MBS( "XL.Book.GetPicture"; $bookRef; $index) ]

See also

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 1st November 2021

XL.Book.GetDefaultFontSize - XL.Book.GetPictureType

💬 Ask a question or report a problem