bBrowser:EnableCaptionClick()

Purpose

Enable or disable the ability to click on column captions with the mouse.

Class

bBrowser

Type

Method

Syntax

<oBrowser>:EnableCaptionClick([<lEnable>]) Æ NIL

Arguments

A logical value that indicates whether column captions can be clicked. If this argument is not specified, the value TRUE is used as default and the ability is enabled.

Data Type:

Logic

Description

The column captions of opened data columns can be clicked or double clicked with the mouse. With this method this ability can be enabled or disabled.

If the ability to click on column captions is enabled, then

1.for each click on a column caption the callback method bBrowser:CaptionClick() is called. This method will automatically call a method of the same name in the owner of the browser if such a method exists.

2.for each double click on a column caption the callback method bBrowser:CaptionDoubleClick() is called. This method will automatically call a method of the same name in the owner of the browser if such a method exists.

Using the method bBrowser:IsCaptionClickable() the attribute can be queried at any time.

After creating a bBrowser control the ability to click on column captions is disabled as default.

Important notes!
Disabling the ability for clicking a column caption does not have any influence on moving columns with the mouse.

If caption click is enabled and in addition the access bBrowser:SelectionMode is #Multiple, then all cells of the column are selected automatically when clicking on the column caption. This behaviour can be disabled when the callback method CaptionClick() in the owner of the bBrowser return the value TRUE.