Class ItemPicker

Provides the possibility to pick items from a list of items.

Inheritance
object
DispatcherObject
DependencyObject
Visual
UIElement
FrameworkElement
Control
ItemPicker
Namespace: Sartorius.SAF.Presentation.Controls
Assembly: Sartorius.SAF.Presentation.Controls.dll
Syntax
[TemplatePart(Name = "PART_RemainingItems", Type = typeof(MultiSelector))]
[TemplatePart(Name = "PART_SelectedItems", Type = typeof(MultiSelector))]
[Export(typeof(IItemPicker))]
[PartCreationPolicy(CreationPolicy.NonShared)]
[SuppressMessage("Design", "CA1033:Interface methods should be callable by child types", Justification = "Breaking changes.")]
public class ItemPicker : Control, IAnimatable, ISupportInitialize, IFrameworkInputElement, IInputElement, IQueryAmbient, IItemPicker, IContentDialogContext, IDialogContext, IDataErrorInfo
Remarks

Use the IItemPicker interface to show the control as a dialog.

Examples

The following example shows how to use the ItemPicker custom control by binding the available items and binding to the IsSelectedMemberPath. User ordering is enabled and the OrderMemberPath is bound. Two properties ('ID' and 'ShortDescription') of the picked items will be shown as columns in the item picker. Select/Unselect all buttons will be shown.

<SAF:ItemPicker AllowSelectAll="True"
                AvailableItems="{Binding Items}"
                SelectionEmptyTitle="No Items selected"
                SelectionEmptyMessage="Use the 'select' button in the header or double click items to select them."
                IsSelectionOrdered="True"
                IsSelectedMemberPath="IsSelected"
                IsSelectedMemberConverter="{StaticResource VisibilityToBooleanConverter}"
                OrderMemberPath="SortOrder">
    <SAF:ItemPicker.Columns>
        <SAF:ColumnDescriptor Header="Item ID" MemberName="ID" />
        <SAF:ColumnDescriptor Header="Short Description" MemberName="ShortDescription" />
    </SAF:ItemPicker.Columns>
</SAF:ItemPicker>

The following example shows how to use the ItemPicker custom control by binding to the available items and binding to the IsSelectedMemberPath. User sorting is not enabled and all properties of the picked items will be shown as columns in the picker. This includes the IsSelected property!

<SAF:ItemPicker AvailableItems="{Binding Items}"
                IsSelectedMemberPath="IsSelected"
                IsSelectedMemberConverter="{StaticResource VisibilityToBooleanConverter}" />

The following example shows how to bind the SelectedItems property to a property named SelectedUsers in your viewmodel.

<SAF:ItemPicker x:Name="UserPicker"
                AvailableItems="{Binding Items}">
    <SAF:ItemPicker.Columns>
        <SAF:ColumnDescriptor Header="Name" MemberName="Name" />
    </SAF:ItemPicker.Columns>
    <SAF:Interaction.Pipes>
        <SAF:DependencyPropertyPipe Source="{Binding SelectedItems, ElementName=UserPicker}"
                                    Target="{Binding SelectedUsers, Mode=OneWayToSource}" />
        <SAF:EventPipe EventName="SelectionChanged" Command="{Binding SelectionChangedCommand}" />
    </SAF:Interaction.Pipes>
</SAF:ItemPicker>

Constructors

View Source

ItemPicker()

Initializes a new instance of the ItemPicker class.

Declaration
public ItemPicker()

Fields

View Source

AllSelectedMessageProperty

Identifies the DependencyProperty for AllSelectedMessage.

Declaration
public static readonly DependencyProperty AllSelectedMessageProperty
Field Value
Type Description
DependencyProperty
View Source

AllSelectedTitleProperty

Identifies the DependencyProperty for AllSelectedTitle.

Declaration
public static readonly DependencyProperty AllSelectedTitleProperty
Field Value
Type Description
DependencyProperty
View Source

AllowSelectAllProperty

Identifies the DependencyProperty for AllowSelectAll.

Declaration
public static readonly DependencyProperty AllowSelectAllProperty
Field Value
Type Description
DependencyProperty
View Source

AutoMarkNextItemProperty

Identifies the DependencyProperty for AutoMarkNextItem.

Declaration
public static readonly DependencyProperty AutoMarkNextItemProperty
Field Value
Type Description
DependencyProperty
View Source

AvailableItemsProperty

Identifies the DependencyProperty for AvailableItems.

Declaration
public static readonly DependencyProperty AvailableItemsProperty
Field Value
Type Description
DependencyProperty
View Source

AvailableTitleProperty

Identifies the DependencyProperty for AvailableTitle.

Declaration
public static readonly DependencyProperty AvailableTitleProperty
Field Value
Type Description
DependencyProperty
View Source

ColumnsProperty

Identifies the DependencyProperty for Columns.

Declaration
public static readonly DependencyProperty ColumnsProperty
Field Value
Type Description
DependencyProperty
View Source

EmptyFilteredMessageProperty

Identifies the DependencyProperty for EmptyFilteredMessage.

Declaration
public static readonly DependencyProperty EmptyFilteredMessageProperty
Field Value
Type Description
DependencyProperty
View Source

EmptyFilteredTitleProperty

Identifies the DependencyProperty for EmptyFilteredTitle.

Declaration
public static readonly DependencyProperty EmptyFilteredTitleProperty
Field Value
Type Description
DependencyProperty
View Source

IsSelectedMemberConverterParameterProperty

Identifies the DependencyProperty for IsSelectedMemberConverterParameter.

Declaration
public static readonly DependencyProperty IsSelectedMemberConverterParameterProperty
Field Value
Type Description
DependencyProperty
View Source

IsSelectedMemberConverterProperty

Identifies the DependencyProperty for IsSelectedMemberConverter.

Declaration
public static readonly DependencyProperty IsSelectedMemberConverterProperty
Field Value
Type Description
DependencyProperty
View Source

IsSelectedMemberPathProperty

Identifies the DependencyProperty for IsSelectedMemberPath.

Declaration
public static readonly DependencyProperty IsSelectedMemberPathProperty
Field Value
Type Description
DependencyProperty
View Source

IsSelectionOrderedProperty

Identifies the DependencyProperty for IsSelectionOrdered.

Declaration
public static readonly DependencyProperty IsSelectionOrderedProperty
Field Value
Type Description
DependencyProperty
View Source

ItemDoubleClickCommandProperty

Identifies the DependencyProperty for ItemDoubleClickCommand.

Declaration
public static readonly DependencyProperty ItemDoubleClickCommandProperty
Field Value
Type Description
DependencyProperty
View Source

MarkAllCommandProperty

Identifies the DependencyProperty for MarkAllCommand.

Declaration
public static readonly DependencyProperty MarkAllCommandProperty
Field Value
Type Description
DependencyProperty
View Source

MarkAllCommandTooltipProperty

Identifies the DependencyProperty for a tooltip of the command MarkAllCommand.

Declaration
public static readonly DependencyProperty MarkAllCommandTooltipProperty
Field Value
Type Description
DependencyProperty
View Source

MarkedRemainingItemsProperty

Identifies the DependencyProperty for MarkedRemainingItems.

Declaration
public static readonly DependencyProperty MarkedRemainingItemsProperty
Field Value
Type Description
DependencyProperty
View Source

MarkedSelectedItemsProperty

Identifies the DependencyProperty for MarkedSelectedItems.

Declaration
public static readonly DependencyProperty MarkedSelectedItemsProperty
Field Value
Type Description
DependencyProperty
View Source

MaxNumberOfSelectableRemainingItemsProperty

Identifies the DependencyProperty for MaxNumberOfSelectableRemainingItems.

Declaration
public static readonly DependencyProperty MaxNumberOfSelectableRemainingItemsProperty
Field Value
Type Description
DependencyProperty
View Source

MaxSelectedItemCountProperty

Identifies the DependencyProperty for MaxSelectedItemCount.

Declaration
public static readonly DependencyProperty MaxSelectedItemCountProperty
Field Value
Type Description
DependencyProperty
View Source

MoveDownCommandProperty

Identifies the DependencyProperty for MoveDownCommand.

Declaration
public static readonly DependencyProperty MoveDownCommandProperty
Field Value
Type Description
DependencyProperty
View Source

MoveDownCommandTooltipProperty

Identifies the DependencyProperty for a tooltip of the command MoveDownCommand.

Declaration
public static readonly DependencyProperty MoveDownCommandTooltipProperty
Field Value
Type Description
DependencyProperty
View Source

MoveUpCommandProperty

Identifies the DependencyProperty for MoveUpCommand.

Declaration
public static readonly DependencyProperty MoveUpCommandProperty
Field Value
Type Description
DependencyProperty
View Source

MoveUpCommandTooltipProperty

Identifies the DependencyProperty for a tooltip of the command MoveUpCommand.

Declaration
public static readonly DependencyProperty MoveUpCommandTooltipProperty
Field Value
Type Description
DependencyProperty
View Source

OrderMemberConverterParameterProperty

Identifies the DependencyProperty for OrderMemberConverter.

Declaration
public static readonly DependencyProperty OrderMemberConverterParameterProperty
Field Value
Type Description
DependencyProperty
View Source

OrderMemberConverterProperty

Identifies the DependencyProperty for OrderMemberConverter.

Declaration
public static readonly DependencyProperty OrderMemberConverterProperty
Field Value
Type Description
DependencyProperty
View Source

OrderMemberPathProperty

Identifies the DependencyProperty for OrderMemberPath.

Declaration
public static readonly DependencyProperty OrderMemberPathProperty
Field Value
Type Description
DependencyProperty
View Source

RemainingItemsViewProperty

Identifies the DependencyProperty for RemainingItemsView.

Declaration
public static readonly DependencyProperty RemainingItemsViewProperty
Field Value
Type Description
DependencyProperty
View Source

SelectedItemsProperty

Identifies the DependencyProperty for the SelectedItems.

Declaration
public static readonly DependencyProperty SelectedItemsProperty
Field Value
Type Description
DependencyProperty
View Source

SelectedItemsViewProperty

Identifies the DependencyProperty for SelectedItemsView.

Declaration
public static readonly DependencyProperty SelectedItemsViewProperty
Field Value
Type Description
DependencyProperty
View Source

SelectedTitleProperty

Identifies the DependencyProperty for SelectedTitle.

Declaration
public static readonly DependencyProperty SelectedTitleProperty
Field Value
Type Description
DependencyProperty
View Source

SelectionCountFormatProperty

Identifies the DependencyProperty for SelectedTitle.

Declaration
public static readonly DependencyProperty SelectionCountFormatProperty
Field Value
Type Description
DependencyProperty
View Source

SelectionEmptyMessageProperty

Identifies the DependencyProperty for SelectionEmptyMessage.

Declaration
public static readonly DependencyProperty SelectionEmptyMessageProperty
Field Value
Type Description
DependencyProperty
View Source

SelectionEmptyTitleProperty

Identifies the DependencyProperty for SelectionEmptyTitle.

Declaration
public static readonly DependencyProperty SelectionEmptyTitleProperty
Field Value
Type Description
DependencyProperty
View Source

UnmarkAllCommandProperty

Identifies the DependencyProperty for UnmarkAllCommand.

Declaration
public static readonly DependencyProperty UnmarkAllCommandProperty
Field Value
Type Description
DependencyProperty
View Source

UnmarkAllCommandTooltipProperty

Identifies the DependencyProperty for a tooltip of the command UnmarkAllCommand.

Declaration
public static readonly DependencyProperty UnmarkAllCommandTooltipProperty
Field Value
Type Description
DependencyProperty

Properties

View Source

AllSelectedMessage

Gets or sets the message shown when all available items have been selected.

Declaration
public string AllSelectedMessage { get; set; }
Property Value
Type Description
string

The message shown when all available items have been selected.
View Source

AllSelectedTitle

Gets or sets the title of the message shown when all available items have been selected.

Declaration
public string AllSelectedTitle { get; set; }
Property Value
Type Description
string

The title of the message shown when all available items have been selected.
View Source

AllowSelectAll

Gets or sets a value indicating whether the user can select/deselect all items in a box with the select all/none button.

Declaration
public bool AllowSelectAll { get; set; }
Property Value
Type Description
bool

true if the user is allowed to select all; otherwise, false.
View Source

AutoMarkNextItem

Gets or sets a value indicating whether the auto mark next item

Declaration
public bool AutoMarkNextItem { get; set; }
Property Value
Type Description
bool
View Source

AvailableItems

Gets or sets the available items.

Declaration
public IEnumerable AvailableItems { get; set; }
Property Value
Type Description
IEnumerable
View Source

AvailableTitle

Gets or sets the title for the available selection box.

Declaration
public string AvailableTitle { get; set; }
Property Value
Type Description
string
View Source

Columns

Gets or sets the columns visible in the selection grids.

Declaration
[SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "Is /can be used as dependency property in Xaml.")]
public ColumnDescriptorCollection Columns { get; set; }
Property Value
Type Description
ColumnDescriptorCollection
View Source

EmptyFilteredMessage

Gets or sets the message shown when a list has been filtered empty.

Declaration
public string EmptyFilteredMessage { get; set; }
Property Value
Type Description
string

The message shown when a list has been filtered empty.
View Source

EmptyFilteredTitle

Gets or sets the title shown when a list has been filtered empty.

Declaration
public string EmptyFilteredTitle { get; set; }
Property Value
Type Description
string

The title shown when a list has been filtered empty.
View Source

FirstButtonCaption

The caption of the first button

Declaration
public string FirstButtonCaption { get; set; }
Property Value
Type Description
string
View Source

FirstCommand

Command for first button

Declaration
public ICommand FirstCommand { get; }
Property Value
Type Description
ICommand
View Source

Info

An information message.

Declaration
public string Info { get; set; }
Property Value
Type Description
string
View Source

IsSelectedMemberConverter

Gets or sets the IValueConverter that is used to convert the value defined by IsSelectedMemberPath to a bool.

Declaration
public IValueConverter IsSelectedMemberConverter { get; set; }
Property Value
Type Description
IValueConverter

The IValueConverter needed to convert the value defined by IsSelectedMemberPath to a bool
View Source

IsSelectedMemberConverterParameter

Gets or sets the parameter used for the IsSelectedMemberConverter.

Declaration
public object IsSelectedMemberConverterParameter { get; set; }
Property Value
Type Description
object

The is selected member converter parameter.
View Source

IsSelectedMemberPath

Gets or sets a path to a value on the source object that defines whether the object is selected.

Declaration
public string IsSelectedMemberPath { get; set; }
Property Value
Type Description
string

The path to a value on the source object. This can be any path, or an XPath such as "@IsSelected". The default is an empty string.
View Source

IsSelectionOrdered

Gets or sets a value indicating whether the selection is ordered.

Declaration
public bool IsSelectionOrdered { get; set; }
Property Value
Type Description
bool

true if the selection ordered; otherwise, false.
Remarks

If the selection is ordered the user can order it in the item picker.

View Source

ItemDoubleClickCommand

Gets or sets the command that should be executed when an item has been double clicked.

Declaration
public ICommand ItemDoubleClickCommand { get; }
Property Value
Type Description
ICommand

The item double click command.
View Source

MarkAllCommand

Gets or sets a command selecting all remaining items.

Declaration
public ICommand MarkAllCommand { get; set; }
Property Value
Type Description
ICommand

A command selecting all remaining items
Remarks

Provide the MultiSelector defined by 'PART_RemainingItems' or 'PART_SelectedItems' as CommandParameter

View Source

MarkAllCommandTooltip

Gets or sets a tooltip for the command MarkAllCommand.

Declaration
public string MarkAllCommandTooltip { get; set; }
Property Value
Type Description
string
View Source

MarkedRemainingItems

Gets or sets the remaining items that are currently selected in the MultiSelector identified by Sartorius.SAF.Presentation.Controls.ItemPicker.PartNameAvailableItemsSelector.

Declaration
[SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "Is /can be used as dependency property in Xaml.")]
public IList MarkedRemainingItems { get; set; }
Property Value
Type Description
IList

The remaining items that are currently selected in the remaining items selector.
View Source

MarkedSelectedItems

Gets or sets the selected items that are currently selected in the MultiSelector identified by Sartorius.SAF.Presentation.Controls.ItemPicker.PartNameSelectedItemsSelector.

Declaration
[SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "Is /can be used as dependency property in Xaml.")]
public IList MarkedSelectedItems { get; set; }
Property Value
Type Description
IList

The selected items that are currently selected in the selected items selector.
View Source

MaxNumberOfSelectableRemainingItems

Gets or sets the maximum number of remaining items that can still be selected.

Declaration
public int MaxNumberOfSelectableRemainingItems { get; }
Property Value
Type Description
int

The maximum number of remaining items that can still be selected.
View Source

MaxSelectedItemCount

Gets or sets the maximum selected item count.

Declaration
public int? MaxSelectedItemCount { get; set; }
Property Value
Type Description
int?

The maximum selected item count.
View Source

MoveDownCommand

Gets or sets a command triggering an down move of the currently selected item.

Declaration
public ICommand MoveDownCommand { get; set; }
Property Value
Type Description
ICommand

A command triggering an down move of the currently selected item.
View Source

MoveDownCommandTooltip

Gets or sets a tooltip for the command MoveDownCommand.

Declaration
public string MoveDownCommandTooltip { get; set; }
Property Value
Type Description
string

A tooltip of the command MoveDownCommand.
View Source

MoveUpCommand

Gets or sets a command triggering an upward move of the currently selected item.

Declaration
public ICommand MoveUpCommand { get; set; }
Property Value
Type Description
ICommand

A command triggering an upward move of the currently selected item.
View Source

MoveUpCommandTooltip

Gets or sets a tooltip for the command MoveUpCommand.

Declaration
public string MoveUpCommandTooltip { get; set; }
Property Value
Type Description
string

A tooltip of the command MoveUpCommand.
View Source

OrderMemberConverter

Gets or sets the IValueConverter used to convert the value defined by the OrderMemberPath to an int.

Declaration
public IValueConverter OrderMemberConverter { get; set; }
Property Value
Type Description
IValueConverter

The IValueConverter needed to convert the value defined by IsSelectedMemberPath to a bool
View Source

OrderMemberConverterParameter

Gets or sets the parameter used for the OrderMemberConverter.

Declaration
public object OrderMemberConverterParameter { get; set; }
Property Value
Type Description
object

The order member converter parameter.
View Source

OrderMemberPath

Gets or sets a path to a value on the source object that defines the order of the item.

Declaration
public string OrderMemberPath { get; set; }
Property Value
Type Description
string

The path to a value on the source object. This can be any path, or an XPath such as "@Order". The default is an empty string.
View Source

RemainingItemsView

Gets a ICollectionView of all remaining items that have not been selected yet.

Declaration
public ICollectionView RemainingItemsView { get; }
Property Value
Type Description
ICollectionView

A ICollectionView of all remaining items that have not been selected yet.
View Source

SecondButtonCaption

The caption of the second button

Declaration
public string SecondButtonCaption { get; set; }
Property Value
Type Description
string
View Source

SecondCommand

Command for second button

Declaration
public ICommand SecondCommand { get; }
Property Value
Type Description
ICommand
View Source

SelectCommandTooltip

Gets or sets a tooltip for the command Sartorius.SAF.Presentation.Controls.ItemPicker.SelectCommand.

Declaration
public string SelectCommandTooltip { get; set; }
Property Value
Type Description
string

A tooltip of the command Sartorius.SAF.Presentation.Controls.ItemPicker.SelectCommand.
View Source

SelectedItems

Gets the items that are selected in the ItemPicker.

Declaration
[Bindable(true)]
public IList SelectedItems { get; }
Property Value
Type Description
IList

The items that are selected in the ItemPicker.
View Source

SelectedItemsView

Gets a ListCollectionView of all items currently selected.

Declaration
public ListCollectionView SelectedItemsView { get; }
Property Value
Type Description
ListCollectionView

A ListCollectionView of all items currently selected.
View Source

SelectedTitle

Gets or sets the title for the selected selection box.

Declaration
public string SelectedTitle { get; set; }
Property Value
Type Description
string
View Source

SelectionCountFormat

Gets or sets the string used to format the current selection count (e.g. 3/10).

Declaration
public string SelectionCountFormat { get; set; }
Property Value
Type Description
string
Remarks

The default is ({0}/{1}).

View Source

SelectionEmptyMessage

Gets or sets the message shown when no items have been selected (yet).

Declaration
public string SelectionEmptyMessage { get; set; }
Property Value
Type Description
string

The message shown when no items have been selected (yet).
View Source

SelectionEmptyTitle

Gets or sets the title for the message shown when no items have been selected (yet).

Declaration
public string SelectionEmptyTitle { get; set; }
Property Value
Type Description
string

The title for the message shown when no items have been selected (yet).
View Source

ServiceFactory

Gets the service factory.

Declaration
protected IServiceFactory ServiceFactory { get; }
Property Value
Type Description
IServiceFactory

The service factory.
View Source

UnmarkAllCommand

Gets or sets a command that marks all remaining items for selection.

Declaration
public ICommand UnmarkAllCommand { get; set; }
Property Value
Type Description
ICommand

A command that marks all remaining items for selection
Remarks

Provide the MultiSelector defined by 'PART_RemainingItems' or 'PART_SelectedItems' as CommandParameter

View Source

UnmarkAllCommandTooltip

Gets or sets a tooltip for the command UnmarkAllCommand.

Declaration
public string UnmarkAllCommandTooltip { get; set; }
Property Value
Type Description
string

A tooltip of the command UnmarkAllCommand.
View Source

UnselectCommandTooltip

Gets or sets a tooltip for the command Sartorius.SAF.Presentation.Controls.ItemPicker.UnselectCommand.

Declaration
public string UnselectCommandTooltip { get; set; }
Property Value
Type Description
string

A tooltip of the command Sartorius.SAF.Presentation.Controls.ItemPicker.UnselectCommand.

Methods

View Source

OnClose(MessageBoxResult)

Raises CloseDialog and Closed events.

Declaration
protected void OnClose(MessageBoxResult result)
Parameters
Type Name Description
MessageBoxResult result

The result.
View Source

OnKeyUp(KeyEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.KeyUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration
protected override void OnKeyUp(KeyEventArgs e)
Parameters
Type Name Description
KeyEventArgs e

The KeyEventArgs that contains the event data.
Overrides

Implements

Extension Methods

See Also