onLabelEdit (Callback)


allow = onLabelEdit (control, code, item, STRING text)

This callback is invoked when the user attempts to edit a label.

Parameter Description
control The id of the control which generated the event
code A constant which identifies what kind of label editing event occured. See remarks for a list of constants.
item The item the user is attempting to edit the label for
STRING text The new text for the label or the empty string if not applicable

Returns

$$TRUE to allow, $$FALSE to cancel

Remarks

This is a callback function. You must supply this function yourself. To register this function, use the WinXRegOnLabelEdit function.

Possible values for the code parameter are:

$$EDIT_START
The user is attempting to edit a label. Return $$TRUE to allow or $$FALSE to cancel
$$EDIT_DONE
The user has finished editing a label. The text parameter will contain the new label for the control. Return $$TRUE to change the label or $$FALSE to cancel. If the new label is the empty string and you return $$TRUE, the label will not change.

Examples

See the tree view demo program in the samples folder

Related Links

WinXRegOnLabelEdit