ObjectDCL Banner

PictureBox_LoadPictureFile Method

Description

This method will load a picture file of type .bmp, .ico, .jpg, and .wmf, into the PictureBox control.

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.
FileName
String identifying the file name of the picture to load.
Stretch
Boolean identifying whether to stretch the picture to the limits of the picture box.

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_LoadPictureFile 
		MyControlReference [as Reference]
		FileName [as String] 
		[Optional] Stretch [as Boolean])

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_LoadPictureFile
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		FileName [as String] 
		[Optional] Stretch [as Boolean])

Remarks

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

Applies For

PictureBox.

Example

CopyCode imageCopy Code
; Load a picture
(Odcl_PictureBox_LoadPictureFile MyProject_MyForm_MyControl "Balloon.bmp")

See Also

PictureBox_PaintPicture, PictureBox_Refresh, PictureBox_StoreImage