Skip to content

ImageControl element (Thmutil extension)

Defines an image control.

Attributes

EnableCondition

string

A condition that determines if the control is enabled. If this condition is true or omitted, then the control will be enabled.

Height

integer required

Height of the control. Non-positive values extend the control to the bottom of the window minus the value. A zero value extends the control to the bottom of the window.

HexStyle

hex

Hexadecimal window style for the control.

HideWhenDisabled

yesno

Specifies whether the control should be hidden when disabled.

ImageFile

string

Relative path to an image file for the control. Mutually exclusive with ImageId and ImageResource and SourceX and SourceY attributes.

ImageId

string

Identifier to the Image element that serves as the image for the control. Mutually exclusive with ImageFile and ImageResource and SourceX and SourceY attributes.

ImageResource

non-negative integer

Identifier that references an image resource with type RT_RCDATA in the module for the control. Mutually exclusive with ImageId and ImageFile and SourceX and SourceY attributes.

Name

string

Optional name for the control.

If the ThmUtil variable callback system has been configured, such as by WixStandardBootstrapperApplication, ThmUtil uses the control name to find a matching variable name. ThmUtil retrieves the variable’s value to set the initial value of the control and sets the variable’s value when the user interacts with the control.

For example, a checkbox control is checked when the matching variable has a nonzero value and unchecked for a value of 0. When the user checks a checkbox control, ThmUtil sets the variable value to a nonzero value (currently 1) and to 0 if the checkbox is unchecked.

An edit box control gets its initial value from a matching variable value. The control value is saved to the variable when navigating away from the page or when choosing a folder via an associated Browse button.

SourceX

non-negative integer

X offset of the Theme/@ImageFile or Theme/@ImageResource. Can only be specified with Theme/@ImageFile or Theme/@ImageResource. Mutually exclusive with ImageId and ImageFile and ImageResource attributes.

SourceY

non-negative integer

Y offset of the Theme/@ImageFile or Theme/@ImageResource. Can only be specified with Theme/@ImageFile or Theme/@ImageResource. Mutually exclusive with ImageId and ImageFile and ImageResource attributes.

TabStop

yesno

Specifies whether the control is part of the tab sequence of controls.

Visible

yesno

Specifies whether the control is initially visible.

VisibleCondition

string

A condition that determines if the control is visible. If this condition is true or omitted, then the control will be visible.

Width

integer required

Width of the control. Non-positive values extend the control to the right of the window minus the value. A zero value extends the control to the right of the window.

X

integer required

X coordinate for the control from the left of the window. Negative values are coordinates from the right of the window minus the width of the control.

Y

integer required

Y coordinate for the control from the top of the window. Negative values are coordinates from the bottom of the window minus the height of the control.