XL.Sheet.SetPictureWithSize

Sets a picture with pictureId identifier at position row and col with custom size and offsets in pixels.

Parameters

Parameter	Description	Example	Flags
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
pictureId	The picture identifier number.	$pictureID
width	The picture width to use. Can be -1 or empty for automatic size.	400
height	The picture height to use. Can be -1 or empty for automatic size.	300
X	Relative offset.	0	Optional
Y	Relative offset.	0	Optional
pos	The positioning. 0 = Move and Size, 1 = Move, 2 = Absolute.	0	Optional

Result

Returns OK or error.

Description

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

• GMImage.GetHeight
• GMImage.New
• GMImage.NewFromContainer
• GMImage.Release
• IsError
• XL.Book.AddPictureContainer
• XL.Book.AddPictureFile
• XL.Book.SheetCount
• XL.LoadBook
• XL.Sheet.SetPictureWithScale

Example Databases

• XL/Writing data

This function checks for a license.

Created 18th August 2014, last changed 29th July 2019

XL.Sheet.SetPictureWithScale - XL.Sheet.SetPrintArea