ObjectDCL Banner

PictureBox_Clear Method

Description

This method clears the control, including any pictures set using the Picture property.

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:

CopyCode imageCopy Code
(Odcl_PictureBox_Clear 
		MyControlReference [as Reference])

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

CopyCode imageCopy Code
(Odcl_PictureBox_Clear
		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

CopyCode imageCopy Code
; Clear the painting
(Odcl_PictureBox_Clear MyProject_MyForm_MyControl)