ObjectDCL Banner

PictureBox_GetPictureSize Method

Description

This method will return the size of a picture, indicated by its Id.

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.
PictureID
Picture specifying the picture from the project folder.

Return Values

Returns the following according to the situation:

  • List specifying the size of the picture by width and height.
  • 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_GetPictureSize 
		MyControlReference [as Reference]
		PictureID [as Integer])

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_GetPictureSize
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		PictureID [as Integer])

Remarks

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

Applies For

PictureBox.

Example

CopyCode imageCopy Code
; Get the size of the picture
(Setq rValue (Odcl_PictureBox_GetPictureSize MyProject_MyForm_MyControl 108))