SftBox/OCX 4.5

SftBox.ItemDblClk Event

Softel vdm, Inc.

A mouse button is double-clicked.

Syntax       

VB.NET

Private Sub object_ItemDblClk(ByVal sender As Object, ByVal e As EventArgumentType) Handles object.ItemDblClk

VB

Private Sub object_ItemDblClk(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_ItemDblClk(object sender, EventArgumentType e);

VC++

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

C

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

Delphi

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

object

A SftBox object.

Part

Describes in which part of the combo box the operation has been detected.

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 double clicked.

AreaType

Value

Description

areaSftBoxLabel 

0

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

areaSftBoxTree 

1

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

areaSftBoxItem 1) 

2

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

areaSftBoxCell 1) 

3

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

areaSftBoxColumn

4

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

areaSftBoxRowCol

5

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

areaSftBoxRow

6

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

areaSftBoxColumnRes

7

A column header was double clicked in the column resizing area. ColNum has the column number. ItemIndex is undefined.

areaSftBoxButton 1)

9

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

areaSftBoxStatic

15

The static portion was double 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 ItemDblClk event occurs when a mouse button is double-clicked.

1) If the AutoRespond property is set to True, the areas areaSftBoxButton, areaSftBoxItem and areaSftBoxCell do 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.

Double click events in the drop down portion only occur in a simple combo box or if during the preceding ItemClick event the DropDown.Suppress method was used to suppress showing/hiding the drop down portion. Drop down and drop down list combo boxes usually hide the drop down portion in response to the first mouse click, so a double click is not possible, unless the DropDown.Suppress method is used.

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 ItemDblClk event. The MouseDblClk event can be used instead.

An ItemClick event always precedes the ItemDblClk event.


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