Namespace: Consultingwerk.Windows.Controls
Class 
MultipleItemPickerControl Copy to Clipboard
Parent classes:
Progress.Windows.UserControl
Consultingwerk.Windows.Controls.MultipleItemPickerControl

Inherits: Progress.Windows.UserControl
USE-WIDGET-POOL

File:MultipleItemPickerControl
Purpose:Control that allows selecting multiple items from a list
of items
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Aug 22 14:35:01 CEST 2014
Notes:SCL-417
This Control uses a TableLayoutPanel for layout purposes.
As this Control does not require to be localizable we
do not expect to see the issues described in SCL-205
here

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
# AddSelectedItems () Adds selected items
- btnAddAll_Click (Object, EventArgs) Event handler for the Click event of the btnAddAll
- btnAdd_Click (Object, EventArgs) Event handler for the Click event of the btnAdd
- btnRemoveAll_Click (Object, EventArgs) Event handler for the Click event of the btnRemoveAll
- btnRemove_Click (Object, EventArgs) Event handler for the Click event of the btnRemove
# EnableAddRemoveAll () Enables/Disabled the Add/Remove all button
+ FilterAvailableListItems (character) Filters the available list items
+ Consultingwerk.Framework.Collections.CharacterList GetSelectedItems () Returns the List of selected Items
- InitializeComponent () Initializes the Visual Design
- lvAvailable_ItemDoubleClick (Object, ItemDoubleClickEventArgs) Event handler for the ItemDoubleClick event of the lvAvailable
- lvAvailable_ItemSelectionChanged (Object, ItemSelectionChangedEventArgs) Event handler for the ItemSelectionChanged event of the lvAvailable
- lvSelected_ItemDoubleClick (Object, ItemDoubleClickEventArgs) Event handler for the ItemDoubleClick event of the lvSelected
- lvSelected_ItemSelectionChanged (Object, ItemSelectionChangedEventArgs) Event handler for the ItemSelectionChanged event of the lvSelected
# OnLoad (EventArgs) Raises the Load event
# OnSelectedItemsChanged (EventArgs) Raises the SelectedItemsChanged
# RemoveSelectedItems () Removes selected items
# SelectAll (UltraListView) Selects all items in the given UltraListView Control
+ SetListItems (handle, CharacterList) Initializes the Selection lists based on the given temp-table and CharacterList of selected values

Top Constructor Summary
Options Name Purpose
+ MultipleItemPickerControl () Constructor for the MultipleItemPickerControl class

Top Event Summary
Options Name Purpose
+ SelectedItemsChanged DELEGATE System.EventHandler Raised whenever the List of selected items changes

Top Property Summary
Options Name Purpose
+ CHARACTER DisplayFields
+ CHARACTER DisplayFieldSubstitute
+ CHARACTER ImageKeyField
+ CHARACTER KeyField
+ CHARACTER LabelAvailableItems
+ CHARACTER LabelSelectedItems
+ Infragistics.Win.UltraWinListView.UltraListView ListViewAvailableItems
+ Infragistics.Win.UltraWinListView.UltraListView ListViewSelectedItems
+ LOGICAL SelectedItemsSorted
+ LOGICAL UseStringValue


Method Detail
Top

PROTECTED AddSelectedItems ()
Purpose: Adds selected items
Notes:

Top

PRIVATE btnAddAll_Click (Object, EventArgs)
Purpose: Event handler for the Click event of the btnAddAll
Notes:

Parameters:
sender System.Object
The reference to the Control that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

PRIVATE btnAdd_Click (Object, EventArgs)
Purpose: Event handler for the Click event of the btnAdd
Notes:

Parameters:
sender System.Object
The reference to the Control that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

PRIVATE btnRemoveAll_Click (Object, EventArgs)
Purpose: Event handler for the Click event of the btnRemoveAll
Notes:

Parameters:
sender System.Object
The reference to the Control that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

PRIVATE btnRemove_Click (Object, EventArgs)
Purpose: Event handler for the Click event of the btnRemove
Notes:

Parameters:
sender System.Object
The reference to the Control that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED EnableAddRemoveAll ()
Purpose: Enables/Disabled the Add/Remove all button
Notes:

Top

PUBLIC FilterAvailableListItems (character)
Purpose: Filters the available list items
Notes:

Parameters:
pcFilter CHARACTER
The filter string (MATCHES, * will be added automatically)
Top

PUBLIC Consultingwerk.Framework.Collections.CharacterList GetSelectedItems ()
Purpose: Returns the List of selected Items
Notes: Uses a CHR(1) delimited CharacterList

Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList with the selected items
Top

PRIVATE InitializeComponent ()
Purpose: Initializes the Visual Design
Notes:

Top

PRIVATE lvAvailable_ItemDoubleClick (Object, ItemDoubleClickEventArgs)
Purpose: Event handler for the ItemDoubleClick event of the lvAvailable
Notes:

Parameters:
sender System.Object
The reference to the Control that raised the event
e Infragistics.Win.UltraWinListView.ItemDoubleClickEventArgs
The ItemDoubleClickEventArgs with the data for this event
Top

PRIVATE lvAvailable_ItemSelectionChanged (Object, ItemSelectionChangedEventArgs)
Purpose: Event handler for the ItemSelectionChanged event of the lvAvailable
Notes:

Parameters:
sender System.Object
The reference to the Control that raised the event
e Infragistics.Win.UltraWinListView.ItemSelectionChangedEventArgs
The ItemSelectionChangedEventArgs with the data for this event
Top

PRIVATE lvSelected_ItemDoubleClick (Object, ItemDoubleClickEventArgs)
Purpose: Event handler for the ItemDoubleClick event of the lvSelected
Notes:

Parameters:
sender System.Object
The reference to the Control that raised the event
e Infragistics.Win.UltraWinListView.ItemDoubleClickEventArgs
The ItemDoubleClickEventArgs with the data for this event
Top

PRIVATE lvSelected_ItemSelectionChanged (Object, ItemSelectionChangedEventArgs)
Purpose: Event handler for the ItemSelectionChanged event of the lvSelected
Notes:

Parameters:
sender System.Object
The reference to the Control that raised the event
e Infragistics.Win.UltraWinListView.ItemSelectionChangedEventArgs
The ItemSelectionChangedEventArgs with the data for this event
Top

PROTECTED OnLoad (EventArgs)
Purpose: Raises the Load event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED OnSelectedItemsChanged (EventArgs)
Purpose: Raises the SelectedItemsChanged
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for the event
Top

PROTECTED RemoveSelectedItems ()
Purpose: Removes selected items
Notes:

Top

PROTECTED SelectAll (UltraListView)
Purpose: Selects all items in the given UltraListView Control
Notes:

Parameters:
poListView Infragistics.Win.UltraWinListView.UltraListView
The UltraListView Control to select all items in
Top

PUBLIC SetListItems (handle, CharacterList)
Purpose: Initializes the Selection lists based on the given temp-table and
CharacterList of selected values
Notes:

Parameters:
phTempTable HANDLE
The handle (NOT TABLE-HANDLE) of the temp-table containing all values
poSelectedItems Consultingwerk.Framework.Collections.CharacterList
The CharacterList of selected items


Constructor Detail
Top

PUBLIC MultipleItemPickerControl ()
Purpose: Constructor for the MultipleItemPickerControl class
Notes:



Event Detail
Top

PUBLIC SelectedItemsChanged DELEGATE System.EventHandler
Purpose: Raised whenever the List of selected items changes
Notes:

Delegate: System.EventHandler


Property Detail
Top

PUBLIC CHARACTER DisplayFields

Returns CHARACTER
Top

PUBLIC CHARACTER DisplayFieldSubstitute

Returns CHARACTER
Top

PUBLIC CHARACTER ImageKeyField

Returns CHARACTER
Top

PUBLIC CHARACTER KeyField

Returns CHARACTER
Top

PUBLIC CHARACTER LabelAvailableItems

Returns CHARACTER
Top

PUBLIC CHARACTER LabelSelectedItems

Returns CHARACTER
Top

PUBLIC Infragistics.Win.UltraWinListView.UltraListView ListViewAvailableItems

Returns Infragistics.Win.UltraWinListView.UltraListView
Top

PUBLIC Infragistics.Win.UltraWinListView.UltraListView ListViewSelectedItems

Returns Infragistics.Win.UltraWinListView.UltraListView
Top

PUBLIC LOGICAL SelectedItemsSorted

Returns LOGICAL
Top

PUBLIC LOGICAL UseStringValue

Returns LOGICAL


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:25:12