Skip to content

OnHeaderClick - cCJGrid

Called when a user clicks on a header column

Type: Event

Parameters

Parameter Type Description
iCol Integer The selected column number

Syntax

Procedure OnHeaderClick Integer iCol

Description

OnHeaderClick is called when the user (left) clicks on a header. It is passed the header column clicked. Depending on the value of various properties, this event will invoke a prompt object, change the column focus or re-order the grid. It does the following:

  1. It calls HeaderReorder. Depending on the value of pbHeaderReorders this may reorder / sort the grid.
  2. If pbHeaderPrompts is true and a prompt object exists for the column, it will attempt to give the column the focus and invoke the prompt object.
  3. If pbHeaderSelectsColumn is true, it will attempt to give the column the focus.

You can augment this object to perform other tasks. If you augment this class and you do not forward the message, the default behaviors described above will not occur.