Developer's reference PB2XLS for PowerBuilder

Reference > N_XLS_WORKSHEET > of_insert_bitmap

of_insert_bitmap() method

This method can be used to insert a bitmap into a worksheet. The bitmap must be a 24 bit, true color bitmap without optimization. See Example09.

Syntax

Worksheet.of_insert_bitmap ( Row, Col, Filename{, X, Y{, ScaleWidth, ScaleHeight}})

Parameters

RowThe unsigned integer whose value is the row where top left corner of the image will be placed
ColThe unsigned integer whose value is the column where top left corner of the image will be placed
FilenameA string whose value is the name of the bitmap file you want to insert. If filename is not on the operating system's search path, you must enter the fully qualified name
X (optional)The unsigned integer whose value is the horizontal offset from the top left hand corner of the the cell specified by Row and Col. The offset value is in pixels. Default 0.
Y (optional)The unsigned integer whose value is the vertical offset from the top left hand corner of the the cell specified by Row and Col. Default 0.
ScaleWidth (optional)The double whose value is the horizontal scale factor. Default 1.
ScaleHeight (optional)The double whose value is the vertical scale factor. Default 1.

Description

Note: you must call of_set_row_height() or of_set_column_width() before of_insert_bitmap() if you wish to change the default dimensions of any of the rows or columns that the images occupies

Return value

Integer. Returns 1 if it succeeds and -1 if an error occurs.

Examples

worksheet.of_insert_bitmap( 0, 3, 'c:\images\image.bmp')
worksheet.of_insert_bitmap( 1, 5, 'c:\images\image.bmp', 10, 13)
worksheet.of_insert_bitmap( 1, 5, 'c:\images\image.bmp', 0, 0, 2, 2)