Handling Button controls programmatically

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

Editors

Controls (window/page/report)

Controls

Button control

Handling Button controls programmatically

Overview

Retrieving and modifying the caption of the Button control

Finding out and modifying the state of an On/Off button

Changing the target of a Button control

Modifying the image displayed in the Button control

Properties specific to the management of images in a Button control

See also

The Button control

Handling Button controls programmatically

Overview

WINDEV, WINDEV Mobile and WEBDEV allow you to programmatically handle Button controls. To do so, use the variable of the Button control in the code.

The variable of the Button control:

corresponds to the name of the Button control.
is initialized with the caption of the Button control.

Retrieving and modifying the caption of the Button control

Retrieving the caption

To retrieve the caption of the Button control, use the following syntax:

direct syntax:

<Caption> = <Button control>

using the Caption property:

<Caption> = <Button control>.Caption

<Caption> is Character String variable.

Remark: If the caption is in RTF ("RTF" checked in the "General" tab of the control description), the retrieved caption will contain the RTF tags. To get the caption without the RTF tags, use RTFToText.
For example:

MyCaption is string
MyCaption = RTFToText(BTN_Button.Caption)

Changing the caption

To modify the caption of the Button control, use the following syntax:

<Caption> is Character String variable.

Remark: If the caption is in RTF ("RTF" checked in the "General" tab of the control description), the new caption may (or may not) contain RTF text.

Finding out and modifying the state of an On/Off button

The Pushed property is used to get the state of the Button control:

<State> = <Button control>.Pushed

<State> is a Boolean variable:

True if the button is pressed,
False if the button is released.

Changing the target of a Button control

Modifying the image displayed in the Button control

To change the image displayed in the Button control, use the Image property:

<Button control>.Image = <Image path>

<Image path> is a Character String variable

The following image formats are supported in Windows:

Bitmap (*.BMP)
Graphics Interchange Format (*.gif)
Joint Picture Experts Group (*.jpg ; *.jpeg)
Kodak Photo CD (*.pcd)
PaintBrush (*.pcx)
Adobe Photoshop Format (*.psd)
TrueVision TARGA (*.tga)
Tagged Image File Format (*.tif ; *.tiff)
Remark: the "tiled tiff" option of tiff 6.0 standard is not supported. In this case, we advise you to save the image in tiff 5.0 standard.
Portable Network Graphics (*.png)
Windows MetaFiles (*.emf ; *.wmf)
Icons (*.ico ; *.icw)
Remarks:
- HQ display (High Quality) available.
- Management of sheets in transparent BMP format (32 bits).
Cursors (*.cur)
Portable Document Format (*.pdf)
Scalable Vector Graphics (*.svg)
WINDEV images (generated by the image editor, *.WDPIC).

Remark: To manage the images in TIFF, GIF and JPEG format, Wxxximg.dll must be installed with the other DLLs of WINDEV.

Properties specific to the management of images in a Button control

The following properties are used to programmatically handle the images used in a Button control.


BackgroundImage	Allows you to find out and modify the image associated with the border of a Button control.
BackgroundImageState	Allows you to find out and modify the number of drawings found in the image associated with the border of a Button control.
Image	Allows you to find out and modify the image of a Button control.
ImageState	Allows you to find out and modify the number of drawings found in the image associated with a Button control.
Pushed	Allows you to find out and modify the state of an on/off Button control (pressed or not).
Value	Allows you to find out and modify the caption of a Button control.

For a complete list of WLanguage properties that can be used with a Button control, see Properties associated with Button controls.