SftBox/OCX 4.5

SftBox.ItemClick Event

Softel vdm, Inc.

A mouse button is clicked.

Syntax       

VB.NET

Private Sub object_ItemClick(ByVal sender As Object, ByVal e As EventArgumentType) Handles object.ItemClick

VB

Private Sub object_ItemClick(ByVal Part As SftBoxPortionConstants, ByVal AreaType As SftBoxAreaConstants, ByVal ItemIndex As Long, ByVal ColNum As Integer, ByVal Button As Integer, ByVal Shift As Integer)

C#.NET

void object_ItemClick(object sender, EventArgumentType e);

VC++

void OnItemClickobject(enum SftBoxPortionConstants Part, enum SftBoxAreaConstants AreaType, long ItemIndex, short ColNum, short Button, short Shift);

C

HRESULT OnItemClickobject(enum SftBoxPortionConstants Part, enum SftBoxAreaConstants AreaType, long ItemIndex, short ColNum, short Button, short Shift);

Delphi

procedure objectItemClick(Sender: TObject; Part : TOleEnum; AreaType : TOleEnum; ItemIndex : Integer; ColNum : Smallint; Button : Smallint; Shift : Smallint);

object

A SftBox object.

Part

Describes the area where the mouse button was clicked.

Part

Value

Description

partSftBoxStatic

1

Static portion

partSftBoxEdit

2

Edit control portion

partSftBoxDropDown

3

Drop down portion

AreaType

Describes the area where the mouse button was clicked.

AreaType

Value

Description

areaSftBoxLabel 

0

The label picture was clicked. ItemIndex has the item's index. ColNum is undefined.

areaSftBoxTree 

1

The area where tree lines are shown was clicked. ItemIndex has the item's index. ColNum is undefined.

areaSftBoxItem 

2

The item picture was clicked. ItemIndex has the item's index. ColNum is undefined.

areaSftBoxCell

3

A cell was clicked. ItemIndex and ColNum describe the cell.  If the cell graphic was clicked, the value areaSftBoxCellGraphic is used instead.

areaSftBoxColumn

4

A column header was clicked. ColNum has the column number. ItemIndex is undefined.

areaSftBoxRowCol

5

The row/column header was clicked. ItemIndex and ColNum are undefined.

areaSftBoxRow

6

A row header was clicked. ItemIndex has the item's index. ColNum is undefined.

areaSftBoxCellGraphic

8

A cell graphic was clicked.  ItemIndex and ColNum describe the cell.

areaSftBoxButton 1)

9

The mouse button was pressed on the expand/collapse button. ColNum is undefined.

areaSftBoxStatic

15

The static portion was clicked. ItemIndex and ColNum describe the cell.

ItemIndex

The zero-based index of the item or undefined depending on AreaType.

ColNum

The zero-based column number where the operation has been detected or undefined depending on AreaType.

Button

Describes the button(s) that are pressed. The Button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. The bits set indicate the button that caused the event.

Button

Value

Description

constSftBoxLeftButton

1

The left mouse button was pressed.

constSftBoxRightButton

2

The middle mouse button was pressed.

constSftBoxMiddleButton

4

The right mouse button was pressed.

Shift

Describes the state of the SHIFT, CONTROL and ALT keys. A bit is set if the key is down. The Shift argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. It indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.

Shift

Value

Description

constSftBoxShiftMask

1

The SHIFT key is down.

constSftBoxCtrlMask

2

The CONTROL key is down.

constSftBoxAltMask

4

The ALT key is down.

Comments

The ItemClick event occurs when a mouse button is clicked.

1) If the AutoRespond property is set to True, the area areaSftBoxButton does not generate an ItemClick event for the left mouse button. The combo box control responds by expanding/collapsing the items automatically. The middle and right mouse buttons still generate the event in those areas.

The ItemClick event describes what component of the combo box control was clicked using a combination of Part and AreaType.

Once an ItemClick or ItemDblClk event is processed, the drop down portion may automatically become visible or may be hidden in response. This default action is built into the control. It is possible to suppress the default response by using the DropDown.Suppress method while handling the ItemClick or ItemDblClk event.

The edit control portion does not generate an ItemClick event. The MouseDown and MouseUp events can be used instead.

Certain mouse events, such as clicking on a cell of the drop down portion will select the item and automatically hide the drop down portion. This automatic hiding of the drop down portion can be suppressed using the DropDown.Suppress method. Similarly, clicking on the static portion usually will show the drop down portion. This can also be suppressed using the DropDown.Suppress method.

The ItemDblClk event can be used to respond to double-clicks.

The SelectionChange event occurs when the current selection is changed. While the ItemClick event may indicate a selection change, the SelectionChange event should be used when tracking selections.


Feedback / comments / error reports for this topic
© 2008 - Softel vdm, Inc. - www.softelvdm.com