Get Image Method

Inherits from Generic»GObject»Control Methods.

Returns an image of a front panel object. This method is similar to the Get Panel Image method. 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 Image method to create an image of a front panel object, 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. You also can wire a Property Node to any front panel terminal on the block diagram of the VI for which you want to create a control image. You also can use the Append Control Image to Report VI to create an image of a front panel object and append it to a report.

The following table lists the parameters for this method.

ParametersDescription
image depthSelect the color depth (number of supported colors) of the image: 1 (one-bit, black and white), 4 (four-bit, 16-color), 8 (eight-bit, 256-color), or 24 (24-bit, true-color).
bg colorBackground color of the image.
imageReturns the control image.
colorsSpecifies the colors that appear in the image.
boundsSets the area of the control image.

The following table lists the flags for this method.

Is settable when the VI is runningYes
Requires the block diagram to be loadedN/A
Is available on local LabVIEW onlyN/A
Requires the front panel to be loadedN/A
Must wait until user interface is idleN/A
Is available with control VIsN/A
Is available with global VIsN/A
Is available with strict type definitionsNo
Is available with polymorphic VIsN/A
Available in Run-Time EngineYes (Read/Write)