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

Inherits: Progress.Windows.UserControl

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



Top Method Summary
Options Name Purpose
# AddSelectedItems () Adds selected items
- btnAdd_Click (Object, EventArgs) Event handler for the Click event of the btnAdd
- btnRemove_Click (Object, EventArgs) Event handler for the Click event of the btnRemove
+ 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
# OnSelectedItemsChanged (EventArgs) Raises the SelectedItemsChanged
# RemoveSelectedItems () Removes selected items
+ SetListItems (handle, CharacterList) Initializes the Selection lists based on the given temp-table and CharcaterList 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 Gets and sets the names of the fields that shall be used for the Display text of the items
+ CHARACTER DisplayFieldSubstitute Gets and sets the pattern to be used (SUBSTITUTE function) to build the Display text of the items from the values of the fields in the DisplayFields property
+ CHARACTER ImageKeyField Gets and sets the name of the field that returns the Image Key
+ CHARACTER KeyField Gets and sets the name of the field that returns the Key Value
+ CHARACTER LabelAvailableItems Gets and sets the label for the available items
+ CHARACTER LabelSelectedItems Gets and sets the label for the selected items


Method Detail
Top

PROTECTED AddSelectedItems ()
Purpose: Adds selected items
Notes:

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 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

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 seelcted 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 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

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

Parameters:
phTempTable HANDLE
The handle (NOT TABLE-HANDLE) of the tmep-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
Purpose: Gets and sets the names of the fields that shall be used for the
Display text of the items
Notes: Comma delimited list

Returns CHARACTER
Top

PUBLIC CHARACTER DisplayFieldSubstitute
Purpose: Gets and sets the pattern to be used (SUBSTITUTE function) to build
the Display text of the items from the values of the fields in the
DisplayFields property
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER ImageKeyField
Purpose: Gets and sets the name of the field that returns the Image Key
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER KeyField
Purpose: Gets and sets the name of the field that returns the Key Value
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LabelAvailableItems
Purpose: Gets and sets the label for the available items
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LabelSelectedItems
Purpose: Gets and sets the label for the selected items
Notes:

Returns CHARACTER


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:47:46