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


Adds a picture to the workbook.

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


Parameter Description Example
bookRef The reference to the workbook. Please use XL.LoadBook to load a file. $ref
filepath The native file path to the image file to include. "c:\test.jpg"


Returns image number or error.


Adds a picture to the workbook.
Returns a picture identifier. Supports BMP, DIB, PNG, JPG and WMF picture formats.
Use picture identifier with XL.Sheet.SetPictureWithScale or XL.Sheet.SetPictureWithSize functions.

This function requires a native path. Use Path.FileMakerPathToNativePath to convert a FileMaker path to a native path if required. If you like to have the user choose the path, you can use FileDialog functions.
For Server be aware that server has limited permissions and may not be able to access all files on a computer.

See also

Release notes

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 25th October 2023

XL.Book.AddPictureContainer - XL.Book.AddSheet

💬 Ask a question or report a problem