Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter NineDialog Functions (continued)

ICON Resource Statement

Overview

The ICON statement can be used as part of the body of a dialog resource specification. It is a method for specifying an icon for display within a dialog box static control.

Syntax/Parameters

Syntax

ICON text, id, x, y, width, height, [style], [extended-style]

Parameters

text

Name of an icon (not a file name) defined elsewhere in the resource file.

id

The control identifier. This value must be a 16-bit unsigned integer in the range 0 through 65,535 or -1 (same as 0xFFFF or 65535). Except for -1, control identifiers must be unique. Duplicate control values for the same dialog page will result in an error. id is used to access the control within dialog procedures. A value of -1 is typically used for legends and other static controls and cannot be used for controls that require programmatic access.

x

The X coordinate in dialog units of the left side of the control relative to the left side of the dialog box. This value must be a 16-bit unsigned integer in the range 0 through 65,535. Use caution when overlaying controls.

y

The Y coordinate in dialog units of the top side of the control relative to the top of the dialog box. This value must be a 16-bit unsigned integer in the range 0 through 65,535. Use caution when overlaying controls.

width

The width of the control. This value must be a 16-bit unsigned integer in the range 1 through 65,535. The width is in 1/4-character units.

height

The height of the control. This value must be a 16-bit unsigned integer in the range 1 through 65,535. The height is in 1/8-character units.

style

An optional predefined name or literal integer value that specifies the style of the control. The only allowable style is the default style: SS_ICON.

extended-style

An optional extended window style. The style parameter must be specified in order to specify extended-style. For more information, see EXSTYLE.

Remarks

Icons appear at the top of the dialog box beside the dialog caption. The ICON resource statement can only be used with the DIALOGEX statement.

The icon specifies a control, the icon must be loaded using the StaticControlSetImage function.