DoubleClicked

The DoubleClicked event has different arguments for different objects:

Object

See

ListBox, PictureListBox, ListView, and Tab controls

Syntax 1

TreeView control

Syntax 2

Window

Syntax 3

Other controls

Syntax 4


For information about the DataWindow control's DoubleClicked event, see the the section called “DoubleClicked” in DataWindow Reference.

Syntax 1: For ListBox, PictureListBox, ListView, and Tab controls

Description

Occurs when the user double-clicks on the control.

Event ID

Event ID

Objects

pbm_lbndblclk

ListBox, PictureListBox

pbm_lvndoubleclicked

ListView

pbm_tcndoubleclicked

Tab


Arguments

Argument

Description

index

Integer by value. The index of the item the user double-clicked (for tabs, the index of the tab page).


Return Values

Long.

Return code choices (specify in a RETURN statement):

0 -- Continue processing

Usage

You can use the ItemActivate event (with the OneClickActivate property set to false) instead of the DoubleClicked event for ListView controls.

In a ListBox or PictureListBox, double-clicking on an item also triggers a SelectionChanged event.

Examples

This example uses the DoubleClicked event to begin editing the double-clicked ListView item:

This.EditLabels = TRUE

See also

Clicked

ColumnClick

ItemActivate

ItemChanged

ItemChanging

RightClicked

RightDoubleClicked

SelectionChanged

SelectionChanging

Syntax 2: For TreeView controls

Description

Occurs when the user double-clicks on the control.

Event ID

Event ID

Objects

pbm_tvndoubleclicked

TreeView


Arguments

Argument

Description

handle

Long by value (the handle of the item the user double-clicked)


Return Values

Long.

Return code choices (specify in a RETURN statement):

0 -- Continue processing

Examples

This example turns on editing for the double-clicked TreeView item:

TreeViewItem ltvi_current
ltvi_current = tv_1.FindItem(CurrentTreeItem!, 0)
This.EditLabel(ltvi_current)

See also

Clicked

RightClicked

RightDoubleClicked

SelectionChanged

SelectionChanging

Syntax 3: For windows

Description

Occurs when the user double-clicks in an unoccupied area of the window (any area with no visible, enabled object).

Event ID

Event ID

Objects

pbm_lbuttondblclk

Window


Arguments

Argument

Description

flags

UnsignedLong by value (the modifier keys and mouse buttons that are pressed).

Values are:

  • 1 -- Left mouse button

  • 2 -- Right mouse button

  • 4 -- Shift key

  • 8 -- Ctrl key

  • 16 -- Middle mouse button

In the Clicked event, the left mouse button is being released, so 1 is not summed in the value of flags.

For an explanation of flags, see Syntax 2 of MouseMove.

xpos

Integer by value (the distance of the pointer from the left edge of the window's workspace in pixels).

ypos

Integer by value (the distance of the pointer from the top of the window's workspace in pixels).


Return Values

Long.

Return code choices (specify in a RETURN statement):

0 -- Continue processing

Usage

The xpos and ypos arguments provide the same values the functions PointerX and PointerY return when you call them for the window.

See also

Clicked

MouseDown

MouseMove

MouseUp

RButtonDown

Syntax 4: For other controls

Description

Occurs when the user double-clicks on the control.

Event ID

Event ID

Objects

pbm_bndoubleclicked

Graph, OLE, Picture, PictureHyperLink, StaticText, StaticHyperLink

pbm_cbndblclk

DropDownListBox, DropDownPictureListBox

pbm_lbuttondblclk

DatePicker, MonthCalendar

pbm_prndoubleclicked

HProgressBar, VProgressBar

pbm_rendoubleclicked

RichTextEdit


Arguments

None

Return Values

Long.

Return code choices (specify in a RETURN statement):

0 -- Continue processing

Usage

The DoubleClicked event for DropDownListBoxes is only active when the Always Show List property is on.

See also

Clicked

RButtonDown