Class SelectionOverlay

class that provides a representation of a list in an overlay. Can be used for a data grid to hide/show/replace columns. see DataGrid style

Inheritance
object
DispatcherObject
DependencyObject
Visual
UIElement
FrameworkElement
Control
ItemsControl
Selector
ComboBox
SelectionOverlay
Namespace: Sartorius.SAF.Presentation.Controls
Assembly: Sartorius.SAF.Presentation.Controls.dll
Syntax
[TemplatePart(Name = "PART_EditableTextBox", Type = typeof(TextBox))]
[TemplatePart(Name = "PART_Popup", Type = typeof(Popup))]
[TemplatePart(Name = "PART_HeaderPanel", Type = typeof(Panel))]
[SuppressMessage("ReSharper", "LocalizableElement")]
public class SelectionOverlay : ComboBox, IAnimatable, ISupportInitialize, IFrameworkInputElement, IInputElement, IQueryAmbient, IContainItemStorage, IAddChild

Fields

View Source

AlwaysUseMaxHeightProperty

The always use max height property

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

AutoCloseDelayProperty

The auto close delay property

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

CloseButtonStyleProperty

The close button style property

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

CloseButtonToolTipProperty

Defines the dependency property of the CloseButtonToolTip property.

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

CloseButtonVisibilityProperty

The close button visibility property

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

CloseOverlayCommandProperty

The close overlay command property

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

DisableSelectedItemsProperty

The disable selected items property, default is FALSE

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

DisplayPropertyProperty

The display property property, defining to which path the default item template's content should bind.

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

HeaderTextBlockStyleProperty

The header text block style property

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

HeaderTextProperty

The header text property

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

IsDropDownOpenProperty

The is drop down open property

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

ItemIsCheckedPropertyConverterProperty

The item is checked property converter property

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

ItemIsCheckedPropertyProperty

The item is checked property path property

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

ItemTypeProperty

The item type property

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

ItemsSourceProperty

The is item source property

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

MaxNoOfSelectedItemsProperty

The max no of selected items property

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

MinNoOfSelectedItemsProperty

The minimum number of selected items property

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

NoSearchResultFoundTextProperty

The text to be shown if search reveals no results

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

NoSearchResultFoundTextVisibilityProperty

Sets visibility of text to be shown if search reveals no results

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

PlacementTargetBackgroundIfDropDownIsOpenProperty

The background property for PlacementTarget if the DropDown of the SelectionOverlay is open

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

PlacementTargetForegroundIfDropDownIsOpenProperty

The foreground property for PlacementTarget if the DropDown of the SelectionOverlay is open

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

PlacementTargetProperty

The placement target property

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

PopupBackgroundProperty

The popup background property

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

PopupHeightProperty

The popup height property

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

PopupStyleProperty

The popup style property

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

SearchTextBoxVisibilityProperty

The search text box visibility property

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

SearchTextProperty

The search text property

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

SearchTextWatermarkProperty

The search text watermark property

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

SelectedItemsProperty

The selected items property

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

StaysOpenProperty

The stays open property, if true, the overlay stays open after selection of an item, otherwise it closes. default: true

Declaration
public static readonly DependencyProperty StaysOpenProperty
Field Value
Type Description
DependencyProperty

Properties

View Source

AutoCloseDelay

Gets or sets the auto close delay in seconds.

Declaration
public double AutoCloseDelay { get; set; }
Property Value
Type Description
double

The auto close delay in seconds.
View Source

CloseButtonStyle

Gets or sets the close button style.

Declaration
public Style CloseButtonStyle { get; set; }
Property Value
Type Description
Style

The close button style.
View Source

CloseButtonToolTip

Gets or sets the close button tooltip.

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

The close button tooltip.
View Source

CloseButtonVisibility

Gets or sets the close button visibility.

Declaration
public Visibility CloseButtonVisibility { get; set; }
Property Value
Type Description
Visibility

The close button visibility.
View Source

CloseOverlayCommand

Gets or sets the close overlay command.

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

The close overlay command.
View Source

DisableSelectedItems

Determines whether selected items are disabled, default is FALSE.

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

Determines whether selected items are disabled, default is FALSE.
View Source

DisplayProperty

Gets or sets the display property path.

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

The display property path.
View Source

HeaderText

Gets or sets the label.

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

The label.
View Source

HeaderTextBlockStyle

Gets or sets the header button style.

Declaration
public Style HeaderTextBlockStyle { get; set; }
Property Value
Type Description
Style

The header button style.
View Source

ItemIsCheckedProperty

Gets or sets the item is checked property path.

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

The item is checked property path.
View Source

ItemIsCheckedPropertyConverter

Gets or sets the item is checked property converter.

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

The item is checked property converter.
View Source

ItemType

Gets or sets the type of the item.

Declaration
public Type ItemType { get; set; }
Property Value
Type Description
Type

The type of the item.
View Source

ItemsDisplayOrder

gets or sets the ItemsDisplayOrder of the items shown in the SelectionOverlay

Declaration
public ItemsDisplayOrderType? ItemsDisplayOrder { get; set; }
Property Value
Type Description
ItemsDisplayOrderType?
View Source

MaxNoOfSelectedItems

Gets or sets the maximum number of selected items.

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

The maximum number of selected items.
View Source

MinNoOfSelectedItems

Gets or sets the minimum number of selected items.

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

The minimum number of selected items.
View Source

NoSearchResultFoundText

Gets or sets the text to be shown for no search results.

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

The NoSearchResult text.
View Source

NoSearchResultFoundTextVisibility

internal use to define the visibility of the NoSearchResultFound test

Declaration
public Visibility NoSearchResultFoundTextVisibility { get; set; }
Property Value
Type Description
Visibility
View Source

OpeningOverlayEventName

Gets or sets the auto close delay in seconds.

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

The auto close delay in seconds.
View Source

PartPopup

the popup part of the selection overlay

Declaration
public Popup PartPopup { get; }
Property Value
Type Description
Popup
View Source

PlacementTarget

Gets or sets the placement target, which the overlay aligns to.

Declaration
public FrameworkElement PlacementTarget { get; set; }
Property Value
Type Description
FrameworkElement

The placement target.
View Source

PlacementTargetBackgroundIfDropDownIsOpen

gets or sets the background color of the placement target id dropDownIsOpen = true

Declaration
public Brush PlacementTargetBackgroundIfDropDownIsOpen { get; set; }
Property Value
Type Description
Brush
View Source

PlacementTargetForegroundIfDropDownIsOpen

gets or sets the foreground color of the placement target id dropDownIsOpen = true

Declaration
public Brush PlacementTargetForegroundIfDropDownIsOpen { get; set; }
Property Value
Type Description
Brush
View Source

PopupBackground

Gets or sets the popup background (default value is SAF_BG_S03).

Declaration
public Color PopupBackground { get; set; }
Property Value
Type Description
Color

The popup background (default value is SAF_BG_S03).
View Source

PopupHeight

Gets or sets the height of the popup.

Declaration
public double PopupHeight { get; set; }
Property Value
Type Description
double
View Source

PopupStyle

Gets or sets the popup style.

Declaration
public Style PopupStyle { get; set; }
Property Value
Type Description
Style

The popup style.
View Source

SearchText

Gets or sets the search text.

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

The search text.
View Source

SearchTextBoxVisibility

Gets or sets the search text box visibility.

Declaration
public Visibility SearchTextBoxVisibility { get; set; }
Property Value
Type Description
Visibility

The search text box visibility.
View Source

SearchTextWatermark

Gets or sets the search text watermark.

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

The search text watermark.
View Source

SelectedItems

Gets or sets the selected items.

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

The selected items.
View Source

SortDescriptionSet

defines whether the SelectionOverlay already defines a SortDescription because of the way it is called: null: user specified (default) with replace functionality (attached properties) = true with selection functionality (attached properties) = false

Declaration
public bool? SortDescriptionSet { get; }
Property Value
Type Description
bool?
View Source

StaysOpen

Gets or sets a value indicating whether the overlay stays open after selection.

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

true if overlay stays open; otherwise, false.

Methods

View Source

ClearContainerForItemOverride(DependencyObject, object)

Clears the items before removes

Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters
Type Name Description
DependencyObject element
object item
Overrides
View Source

GetCloseButtonVisibility(DependencyObject)

Defines the dependency property CloseButtonVisibility. default FALSE

Declaration
public static Visibility GetCloseButtonVisibility(DependencyObject element)
Parameters
Type Name Description
DependencyObject element
Returns
Type Description
Visibility
View Source

GetContainerForItemOverride()

Creates or identifies the element used to display the specified item.

Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
Type Description
DependencyObject

A ComboBoxItem.
Overrides
View Source

GetDisableSelectedItems(DependencyObject)

Defines the dependency property GetDisableSelected. default FALSE

Declaration
public static bool GetDisableSelectedItems(DependencyObject element)
Parameters
Type Name Description
DependencyObject element
Returns
Type Description
bool
View Source

GetDisplayProperty(DependencyObject)

Defines the dependency property DisplayProperty; Default = "Header" (for the bound itemsSource is of type DataGridColumns)

Declaration
public static string GetDisplayProperty(DependencyObject element)
Parameters
Type Name Description
DependencyObject element
Returns
Type Description
string
View Source

GetHeaderText(DependencyObject)

Defines the dependency property HeaderText. default String.Empty

Declaration
public static string GetHeaderText(DependencyObject element)
Parameters
Type Name Description
DependencyObject element
Returns
Type Description
string
View Source

GetItemIsCheckedProperty(DependencyObject)

Defines the dependency property ItemIsChecked; Default = "Visibility"

Declaration
public static string GetItemIsCheckedProperty(DependencyObject element)
Parameters
Type Name Description
DependencyObject element
Returns
Type Description
string
View Source

GetItemIsCheckedPropertyConverter(DependencyObject)

Defines the dependency property ItemIsChecked; Default = VisibilityToBooleanConverter

Declaration
public static IValueConverter GetItemIsCheckedPropertyConverter(DependencyObject element)
Parameters
Type Name Description
DependencyObject element
Returns
Type Description
IValueConverter
View Source

GetItemsDisplayOrderProperty(DependencyObject)

Defines the dependency property ItemsDisplayOrderProperty; Default = "ItemsDisplayOrderType.DefaultView"

Declaration
public static ItemsDisplayOrderType? GetItemsDisplayOrderProperty(DependencyObject element)
Parameters
Type Name Description
DependencyObject element
Returns
Type Description
ItemsDisplayOrderType?
View Source

GetItemsSource(DependencyObject)

REQUIRED when using the SelectionOverlay with attached properties on an element which is not of type DataGrid: (a) in case of a data grid the ItemsSource is set to the DataGridColumns (b) in any case: the ItemsSource must be set

Declaration
public static IEnumerable GetItemsSource(DependencyObject element)
Parameters
Type Name Description
DependencyObject element
Returns
Type Description
IEnumerable
View Source

GetNoSearchResultFoundText(DependencyObject)

Defines the dependency property SearchTextWatermark. default String.Empty

Declaration
public static string GetNoSearchResultFoundText(DependencyObject element)
Parameters
Type Name Description
DependencyObject element
Returns
Type Description
string
View Source

GetOpeningOverlayEventName(DependencyObject)

REQUIRED when using the SelectionOverlay with attached properties: defines the routedEventName dependency property which must be an event defined for (a) DataGridColumnHeader (Button) when the sender of the attached property is a datagrid or (b) in any other case is must be an event of the sender itself

Declaration
public static string GetOpeningOverlayEventName(DependencyObject d)
Parameters
Type Name Description
DependencyObject d

The d.
Returns
Type Description
string
View Source

GetSearchTextBoxVisibility(DependencyObject)

Defines the dependency property SearchTextBoxVisibilityProperty. default Visibility.Visible

Declaration
public static Visibility GetSearchTextBoxVisibility(DependencyObject element)
Parameters
Type Name Description
DependencyObject element
Returns
Type Description
Visibility
View Source

GetSearchTextWatermark(DependencyObject)

Defines the dependency property SearchTextWatermark. default String.Empty

Declaration
public static string GetSearchTextWatermark(DependencyObject element)
Parameters
Type Name Description
DependencyObject element
Returns
Type Description
string
View Source

IsItemItsOwnContainerOverride(object)

Determines if the specified item is (or is eligible to be) its own ItemContainer.

Declaration
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters
Type Name Description
object item

Specified item.
Returns
Type Description
bool

true if the item is its own ItemContainer; otherwise, false.
Overrides
View Source

OnApplyTemplate()

Called when ApplyTemplate() is called.

Declaration
public override void OnApplyTemplate()
Overrides
View Source

PrepareContainerForItemOverride(DependencyObject, object)

Prepares the specified element to display the specified item.

Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
Type Name Description
DependencyObject element

Element used to display the specified item.
object item

Specified item.
Overrides
View Source

RaiseSelectionChanged(SelectionChangedEventArgs)

Raises the selection changed event.

Declaration
protected virtual void RaiseSelectionChanged(SelectionChangedEventArgs e)
Parameters
Type Name Description
SelectionChangedEventArgs e

The SelectionChangedEventArgs instance containing the event data.
View Source

SetCloseButtonVisibility(DependencyObject, Visibility)

Defines the dependency property CloseButtonVisibility. default FALSE

Declaration
public static void SetCloseButtonVisibility(DependencyObject element, Visibility value)
Parameters
Type Name Description
DependencyObject element
Visibility value
View Source

SetDisableSelectedItems(DependencyObject, bool)

Defines the dependency property GetDisableSelected. default FALSE

Declaration
public static void SetDisableSelectedItems(DependencyObject element, bool value)
Parameters
Type Name Description
DependencyObject element
bool value
View Source

SetDisplayProperty(DependencyObject, string)

Defines the dependency property DisplayOrderProperty; Default = "DisplayProperty"

Declaration
public static void SetDisplayProperty(DependencyObject element, string value)
Parameters
Type Name Description
DependencyObject element
string value
View Source

SetHeaderText(DependencyObject, string)

Defines the dependency property HeaderText. default String.Empty

Declaration
public static void SetHeaderText(DependencyObject element, string value)
Parameters
Type Name Description
DependencyObject element
string value
View Source

SetItemIsCheckedProperty(DependencyObject, string)

Defines the dependency property ItemIsChecked; Default = "Visibility"

Declaration
public static void SetItemIsCheckedProperty(DependencyObject element, string value)
Parameters
Type Name Description
DependencyObject element
string value
View Source

SetItemIsCheckedPropertyConverter(DependencyObject, IValueConverter)

Defines the dependency property ItemIsChecked; Default = VisibilityToBooleanConverter

Declaration
public static void SetItemIsCheckedPropertyConverter(DependencyObject element, IValueConverter value)
Parameters
Type Name Description
DependencyObject element
IValueConverter value
View Source

SetItemsDisplayOrderProperty(DependencyObject, ItemsDisplayOrderType)

Defines the dependency property ItemsDisplayOrderProperty; Default = null: and thus order follows DefaultView or when called for DataGrid: special ordering

Declaration
public static void SetItemsDisplayOrderProperty(DependencyObject element, ItemsDisplayOrderType value)
Parameters
Type Name Description
DependencyObject element
ItemsDisplayOrderType value
View Source

SetItemsSource(DependencyObject, IEnumerable)

REQUIRED when using the SelectionOverlay with attached properties on an element which is not of type DataGrid: (a) in case of a data grid the ItemsSource is set to the DataGridColumns (b) in any case: the ItemsSource must be set

Declaration
public static void SetItemsSource(DependencyObject element, IEnumerable value)
Parameters
Type Name Description
DependencyObject element
IEnumerable value
View Source

SetNoSearchResultFoundText(DependencyObject, string)

Defines the dependency property SearchTextWatermark. default String.Empty

Declaration
public static void SetNoSearchResultFoundText(DependencyObject element, string value)
Parameters
Type Name Description
DependencyObject element
string value
View Source

SetOpeningOverlayEventName(DependencyObject, string)

REQUIRED when using the SelectionOverlay with attached properties: defines the routedEventName dependency property which must be an event defined for (a) DataGridColumnHeader (Button) when the sender of the attached property is a data grid or (b) in any other case is must be an event of the sender itself

Declaration
public static void SetOpeningOverlayEventName(DependencyObject d, string value)
Parameters
Type Name Description
DependencyObject d

The d.
string value

The value.
View Source

SetSearchTextBoxVisibility(DependencyObject, Visibility)

Defines the dependency property SearchTextBoxVisibilityProperty. default Visibility.Visible

Declaration
public static void SetSearchTextBoxVisibility(DependencyObject element, Visibility value)
Parameters
Type Name Description
DependencyObject element
Visibility value
View Source

SetSearchTextWatermark(DependencyObject, string)

Defines the dependency property SearchTextWatermark. default String.Empty

Declaration
public static void SetSearchTextWatermark(DependencyObject element, string value)
Parameters
Type Name Description
DependencyObject element
string value

Events

View Source

SelectionChanged

Occurs when the selection has changed. Attention: in the args the added/removed item container is passed.

Declaration
public event SelectionChangedEventHandler SelectionChanged
Event Type
Type Description
SelectionChangedEventHandler

Implements

Extension Methods