Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter NineDialog Functions (continued)

CheckboxSetImage Function

Overview

The CheckboxSetImage function sets an icon or bitmap into a checkbox or radio button control.

Syntax/Parameters

Syntax

int = CheckboxSetImage ( int id, handle hResource | string name );

Parameters

id

An int containing the control ID of a checkbox (button) control.

hResource

A handle to a Resource Object containing an icon or bitmap. Or,

name

A string specifying the name of a resource or a file containing image data in icon or bitmap format.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure, ERROR_RANGE if id is an invalid control ID for the open dialog, or ERROR_INVALID_HANDLE if no dialog is open. Use the GetLastError function to retrieve error information. 

Remarks

The checkbox (button) control receiving the request to display an image must have the matching style set as BS_BITMAP or BS_ICON and the type must match the source resource type. If the image is passed to the control as a Resource Object, the object should remain intact until the dialog box is destroyed. If Resource Object is destroyed prior to the dialog box, the button control will not display the image correctly.

If specified as a direct file or resource name, the size of the icon is set to 16 x 16 pixels. To select a different size, use the LoadIcon function to specify a size.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic