esf1cbabutton

Description

The CBA button is an EPOC 6 Crystal Reference Design specific object. It directly represents one of the four buttons found to the right of the screen. The ESF1 type includes automatically four buttons in the Control Button Array (CBA). The only way to select these buttons is to press the button on the device.

Object Value

None

Type Tags

None

Properties

PropertyTypeAccessDescription
captionstringread-only Contains either the value .nul or the current caption on the button
enabledbooleanread-only This is a boolean value that shows whether the control is enabled or not (a disabled control cannot hold focus or be clicked).
formesf1read-only Contains a reference to the form (if any) to which the control is attached.
nextesf1controlread-only Contains a reference to the next control in the ring of controls in the control button array.
onclickesf1eventread/write Contains a reference to the embedded esf1event that is raised when the control is clicked.
typetyperead-only Contains a reference to the esf1cbabutton type object.

Methods

enable()

Prototype

esf1cbabuttonvar.enable ( boolean enabled )

Description

Enables or disables the control.

Parameters
NameDefaultTypeDescription
enabledNone  An entry of .true enables and .false disables the control.

setcaption()

Prototype

esf1cbabuttonvar.setcaption ( string caption )

Description

Changes the caption of the button. Returns .nul.

Parameters
NameDefaultTypeDescription
caption.nulany text value An entry of .nul or .inf will cause an error, any other value will be assigned although a value can be too long to be completely displayable.