GetPanelImage Method

Installed With: Base Package

Class: VI Methods

Returns an image of the LabVIEW front panel.

If a front panel is not visible, LabVIEW does not update the values in the objects on the front panel. If you call a VI whose front panel is not visible and you use the Get Panel Image method to create an image of the front panel, the image does not reflect any value changes that occurred when you ran the VI. If you want the image to reflect value changes, make sure the front panel is open before any values change.

Syntax

object.GetPanelImage([visibleonly], [imgdepth], [img], [colors], [bounds])

Parameters

Name	Type	Description
visibleonly	Boolean	Sets whether the panel image includes just the objects in the visible area of the front panel or all the front panel objects. The default is TRUE.
imgdepth	Long	Color depth (number of supported colors) for the graphics. The values are 2 (black and white), 16, 256 and 224 (true color).
img	1D array of bytes by ref	Returns the image bitmap as an array of bytes.
colors	1D array of unsigned long by ref	Returns the color table as an array of longs.
bounds	1D array of shorts (four elements) by ref	Returns the bounding rectangle of the image as top, left, bottom, and right values.

Return Value

none