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

XL.Book.AddPictureContainer

Adds a picture to the workbook from container.

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

Parameters

Parameter Description Example
bookRef The reference to the workbook. Please use XL.LoadBook to load a file. $ref
container The container value with the image inside. $container

Result

Returns image number or error.

Description

Adds a picture to the workbook from container.
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.

For XLSX files you can embed SVG graphics with LibXL 4.2 or newer.

Examples

Add a picture to excel sheet:

# add picture to file
Set Variable [$logoID; Value:MBS( "XL.Book.AddPictureContainer"; $book; Writing data::Logo)]
# position with size:
Set Variable [$r; Value:MBS( "XL.Sheet.SetPictureWithSize"; $book; $sheet; 2; 1; $logoID; 100; 100)]
# or with factor:
Set Variable [$r; Value:MBS( "XL.Sheet.SetPictureWithScale"; $book; $sheet; 2; 1; $logoID; .2)]

Adds picture with proportional scaled image:

Set Variable [ $image ; Value: MBS( "GMImage.NewFromContainer"; Writing data::Logo ) ]
If [ MBS("IsError") = 0 ]
    Set Variable [ $destWidth ; Value: 120 ]
    Set Variable [ $destHeight ; Value: 120 ]
    Set Variable [ $width ; Value: MBS( "GMImage.GetWidth"; $image ) ]
    Set Variable [ $height ; Value: MBS( "GMImage.GetHeight"; $image ) ]
    Set Variable [ $r ; Value: MBS( "GMImage.Release"; $image ) ]
    Set Variable [ $factor ; Value: Min ( $destheight / $height; $destwidth / $width ) ]
    Set Variable [ $dwidth ; Value: $width * $factor ]
    Set Variable [ $dheight ; Value: $height * $factor ]
    #
    Set Variable [ $logoID ; Value: MBS( "XL.Book.AddPictureContainer"; $book; Writing data::Logo) ]
    If [ MBS("IsError") = 0 ]
        Set Variable [ $r ; Value: MBS( "XL.Sheet.SetPictureWithSize"; $book; $sheet; 2; 1; $logoID; $dwidth; $dheight) ]
    End If
End If

See also

Example Databases

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 2nd April 2024


XL.Book.AddFormatFromBook - XL.Book.AddPictureFile