PictureBox_StoreImage Method

Description

This method is used to store what has been drawn or printed to the PictureBox's paintable area to memory. What this does is makes all lines, arcs, text, etc. become part of the stored picture that the PictureBox uses to paint from. This method must be called after all objects have been drawn to the PictureBox, or possible errors could occur, especially if another dialog box is moved of the PictureBox and what has been drawn will be erased.

Parameters

MyControlReference: Reference to the control in the form of MyProject_MyForm_MyControl.
ProjectFile: String identifying the project as it was passed in LoadProject.
DialogName: String identifying the dialog by name.
ControlName: String identifying the control by name.

Return Values

Returns the following according to the situation:

T when successful.
Nil if the control is not found or is not visible.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

Copy Code
(Odcl_PictureBox_StoreImage MyControlReference [as Reference])

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

Copy Code
(Odcl_PictureBox_StoreImage ProjectFile [as String] DialogName [as String] ControlName [as String])

Remarks

This function requires that the component is showing. Otherwise it has no effect.

Applies For

PictureBox.

Example

Copy Code
; Capture the painting (Odcl_PictureBox_StoreImage MyProject_MyForm_MyControl)