SelectionChanged

The SelectionChanged event has different arguments for different objects:

Object

See

DropDownListBox, DropDownPictureListBox, ListBox, PictureListBox controls

Syntax 1

Tab control

Syntax 2

TreeView control

Syntax 3

Ribbon item control

Syntax 4


Syntax 1: For Listboxes

Description

Occurs when an item is selected in the control.

Event ID

Event ID

Objects

pbm_cbnselchange

DropDownListBox, DropDownPictureListBox

pbm_lbnselchange

ListBox, PictureListBox


Arguments

Argument

Description

index

Integer by value (the index of the item that has become selected)


Return Values

Long.

Return code choices (specify in a RETURN statement):

0 -- Continue processing

Usage

For DropDownListBoxes, the SelectionChanged event applies to selections in the drop-down portion of the control, not the edit box.

The SelectionChanged event occurs when the user clicks on any item in the list, even if it is the currently selected item. When the user makes a selection using the mouse, the Clicked (and if applicable the DoubleClicked event) occurs after the SelectionChanged event.

Examples

This example is for the lb_value ListBox in the window w_graph_sheet_with_list in the PowerBuilder Examples application. When the user chooses values, they are graphed as series in the graph gr_1. The MultiSelect property for the ListBox is set to true, so index has no effect. The script checks all the items to see if they are selected:

integer itemcount,i,r
string ls_colname
 
gr_1.SetRedraw(FALSE)
 
// Clear out categories, series and data from graph
gr_1.Reset(All!)
 
// Loop through all selected values and
// create as many series as the user specified
FOR i = 1 to lb_value.TotalItems()
   IF lb_value.State(i) = 1 THEN
      ls_colname = lb_value.Text(i)
 
      // Call window function to set up the graph
      wf_set_a_series(ls_colname, ls_colname, &
      lb_category.text(1))
   END IF
NEXT
gr_1.SetRedraw(TRUE)

See also

Clicked

Syntax 2: For Tab controls

Description

Occurs when a tab is selected.

Event ID

Event ID

Objects

pbm_tcnselchanged

Tab


Arguments

Argument

Description

oldindex

Integer by value (the index of the tab that was previously selected)

newindex

Integer by value (the index of the tab that has become selected)


Return Values

Long.

Return code choices (specify in a RETURN statement):

0 -- Continue processing

Usage

The SelectionChanged event occurs when the Tab control is created and the initial selection is set.

See also

Clicked

SelectionChanging

Syntax 3: For TreeView controls

Description

Occurs when the item is selected in a TreeView control.

Event ID

Event ID

Objects

pbm_tvnselchanged

TreeView


Arguments

Argument

Description

oldhandle

Long by value (the handle of the previously selected item)

newhandle

Long by value (the handle of the currently selected item)


Return Values

Long.

Return code choices (specify in a RETURN statement):

0 -- Continue processing

Usage

The SelectionChanged event occurs after the SelectionChanging event.

Examples

This example tracks items in the SelectionChanged event:

TreeViewItem l_tvinew, l_tviold
 
// get the treeview item that was the old selection
This.GetItem(oldhandle, l_tviold)
 
// get the treeview item that is currently selected
This.GetItem(newhandle, l_tvinew)
 
// Display the labels for the two items in sle_get
sle_get.Text = "Selection changed from " &
   + String(l_tviold.Label) + " to " &
   + String(l_tvinew.Label)

See also

Clicked

SelectionChanging

Syntax 4: For Ribbon item controls

Description

This is a user event which occurs when the item is selected in the ribbon combo box control.

Make sure the parameter (quantities and types) of the user event is correctly defined according to the requirement of the ribbon combo box control.

Applies to

RibbonComboBoxItem controls

Arguments

Argument

Description

ItemHandle

Long. The handle of the item.

index

Long. The index of the item selected.


Return Values

Long.

Return code choices (specify in a RETURN statement):

0 -- Continue processing

Example

This example is a user event for a combo box. In this example, the Ue_ComboBoxSelectionChanged user event must be defined with two long parameters for receiving the handle and index number of the combo box which is selected.

//Ue_ComboBoxSelectionChanged user event must have two long parameters for 
//receiving the handle and index number of ComboBox which is selected
event type long ue_comboboxselectionchanged(long itemhandle, long index);
Integer li_Return
String ls_Text

RibbonComboBoxItem lr_ComboBox
li_Return = rbb_1.GetComboBox(ItemHandle,lr_ComboBox)
If li_Return = 1 Then
 ls_Text = lr_ComboBox.Text(Index)
End If

Return 1
end event

See also

Clicked

Modified

Selected