| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
XL.Book.GetPicture
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
Parameters
| 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 |
Result
Returns image or error.
Description
Returns a picture at position index.Returns container value with file, jpeg, gif, tiff or png.
Please use XL.Book.GetPictureType to know the picture type before or Container.GetName and Container.GetTypes after.
Examples
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
- Container.GetName
- Container.GetType
- Container.GetTypes
- XL.Book.GetPictureType
- XL.Book.PictureCount
- XL.LoadBook
- XL.Sheet.GetCellPicture
- XL.Sheet.GetPicture
Release notes
- Version 14.2
- Improved XL.Book.GetPictureType to report future types as number.
- Improved XL.Book.GetPicture to return future pictures types as FILE containers.
- Added SVG for XL.Book.GetPictureType and XL.Book.GetPicture.
- Added work around for XL.Book.GetPicture to return image data, even if LibXL returns an error, but does provide data.
Blog Entries
This function checks for a license.
Created 18th August 2014, last changed 5th April 2024
