Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 7.0   7.1   7.2   7.3   7.4   7.5   8.0   8.1   8.2   8.3    Statistic  

XL.Book.AddPictureFile

Adds a picture to the workbook.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
XL 3.5 Yes Yes Yes Yes Yes

MBS( "XL.Book.AddPictureFile"; bookRef; filepath )

Parameters

Parameter Description Example value
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"

Result

Returns image number or error.

Description

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_setPicture function.

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


XL.Book.AddPictureContainer   -   XL.Book.AddSheet

Feedback: Report problem or ask question.




Links
MBS Xojo Plugins