| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
XL.Sheet.GetCellPicture
Queries picture for a cell.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| XL | 11.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "XL.Sheet.GetCellPicture"; bookRef; sheetIndex; Row; Column ) More
Parameters
| 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 |
| Row | The row for the cell. First row has index 0. | $row |
| Column | The column for the cell. First column has index 0. | $column |
Result
Returns number or error.
Description
Queries picture for a cell.Returns picture index for the book.
Use XL.Book.GetPicture function to retrieve the actual picture data.
There may be multiple cells returning the same picture index here.
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
- XL.Book.GetPicture
- XL.Book.SheetCount
- XL.LoadBook
- XL.Sheet.GetCellError
- XL.Sheet.GetCellErrors
- XL.Sheet.GetPicture
- XL.Sheet.RemovePicture
Release notes
- Version 11.5
- Added XL.Sheet.GetCellPicture function.
Blog Entries
This function checks for a license.
Created 1st November 2021, last changed 1st November 2021
