Class

ListControl

Initializes a new instance of the ListControl class.

Declaration

public ListControl()

Identifies the CanAutocompleteSelectItems dependency property.

Declaration

public static readonly DependencyProperty CanAutocompleteSelectItemsProperty

Field Value

Identifies the CanAutocompleteSelectPartialMatches dependency property.

Declaration

public static readonly DependencyProperty CanAutocompleteSelectPartialMatchesProperty

Field Value

Identifies the CanListControlKeyboardNavigationSelectItems dependency property.

Declaration

public static readonly DependencyProperty CanKeyboardNavigationSelectItemsProperty

Field Value

Identifies the CommandParameter dependency property.

Declaration

public static readonly DependencyProperty CommandParameterProperty

Field Value

Identifies the Command dependency property.

Declaration

public static readonly DependencyProperty CommandProperty

Field Value

Identifies the CommandTarget dependency property.

Declaration

public static readonly DependencyProperty CommandTargetProperty

Field Value

Identifies the IsScrollIntoViewOnSelectionEnabled dependency property. This property determines of the selected item will be automatically scrolled into the view.

Declaration

public static readonly DependencyProperty IsScrollIntoViewEnabledProperty

Field Value

Identifies the TextSearchMode dependency property.

Declaration

public static readonly DependencyProperty TextSearchModeProperty

Field Value

Identifies the TypedText dependency property.

Declaration

public static readonly DependencyProperty TypedTextProperty

Field Value

Gets or sets the autocomplete behavior.

Declaration

protected AutocompleteBehavior AutocompleteBehavior { get; set; }

Property Value

Gets or sets a value that specifies whether the autocomplete should select items, or not. This is a dependency property.

Declaration

public bool? CanAutocompleteSelectItems { get; set; }

Property Value

Gets or sets a value that specifies whether the autocomplete should select partially matching items, or not. This is a dependency property.

Declaration

public bool CanAutocompleteSelectPartialMatches { get; set; }

Property Value

Gets or sets the CanKeyboardNavigationSelectItems. This is a dependency property.

Declaration

public bool? CanKeyboardNavigationSelectItems { get; set; }

Property Value

Gets or sets the Command. This is a dependency property.

Declaration

[TypeConverter(typeof(CommandConverter))]
public ICommand Command { get; set; }

Property Value

Gets or sets the CommandParameter. This is a dependency property.

Declaration

public object CommandParameter { get; set; }

Property Value

Gets or sets the CommandTarget. This is a dependency property.

Declaration

public IInputElement CommandTarget { get; set; }

Property Value

Gets the index of the highlighted item.

Declaration

public int HighlightedIndex { get; }

Property Value

Implements IListControl.HighlightedIndex

Gets or sets the highlighted item.

Declaration

protected object HighlightedItem { get; set; }

Property Value

Gets a value indicating whether the items host is visible. Override if a custom logic is required. Default value is true.

Declaration

protected virtual bool IsItemsHostVisible { get; }

Property Value

Gets or sets the IsScrollIntoViewEnabled. This is a dependency property.

Declaration

public bool IsScrollIntoViewEnabled { get; set; }

Property Value

Gets the keyboard navigation.

Declaration

protected KeyboardNavigation KeyboardNavigation { get; }

Property Value

Gets the command that will be executed when select all. This is a RoutedUICommand.

Declaration

public static RoutedUICommand SelectAllCommand { get; }

Property Value

Gets or sets the text search mode. Specifies how TextSearch will match items. This is a dependency property.

Declaration

public TextSearchMode TextSearchMode { get; set; }

Property Value

Gets or sets the current typed text. This is a dependency property.

Declaration

public string TypedText { get; set; }

Property Value

Indicates whether the selection helper can perform operation or not.

Declaration

protected override bool CanPerformSelection()

Returns

Overrides ItemsControlSelector.CanPerformSelection()

Clears the values for SelectionHelper, ParentSelector and IsSelected properties.

Declaration

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameters

Clears the properties that effect the visual states for the given container. This method is called in ClearContainerForItemOverride(DependencyObject, object)

Declaration

protected virtual void ClearContainerStates(FrameworkElement container)

Parameters

Creates or identifies the element that is used to display the given item.

Declaration

protected override DependencyObject GetContainerForItemOverride()

Returns

Called on initializing the ScrollViewer on template applied. It's mandatory to get the ScrollViewer in order to perform selection.

Declaration

protected virtual ScrollViewer GetScrollViewerPart()

Returns

Remarks

When overridden in a derived class, is invoked whenever application code or internal processes call HandleKeyboardInput(Key). Override this method if a custom keyboard navigation is required.

Declaration

protected virtual bool HandleKeyboardInput(Key key)

Parameters

Returns

Highlights the changed index.

Declaration

[SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
protected virtual void HighlightedIndexChanged(int index, Key key = 0)

Parameters

Determines whether the index is selectable.

Declaration

protected override bool IsIndexSelectable(int index)

Parameters

Returns

Overrides ItemsControlSelector.IsIndexSelectable(int)

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

Declaration

protected override bool IsItemItsOwnContainerOverride(object item)

Parameters

Returns

When overridden in a derived class, is invoked whenever application code or internal processes call .

Declaration

public override void OnApplyTemplate()

Overrides ItemsControlSelector.OnApplyTemplate()

Called when a text is typed.

Declaration

protected virtual void OnAutocompleteBehaviorTypedTextChanged()

Invoked when the property changes.

Declaration

protected override void OnItemsPanelChanged(ItemsPanelTemplate oldItemsPanel, ItemsPanelTemplate newItemsPanel)

Parameters

When overridden in a derived class, is invoked whenever application code or internal processes call OnMatchingItemChanged(). Called when matching item is changed. Override this method if a custom logic is required when an item is changed.

Declaration

protected virtual void OnMatchingItemChanged()

Declaration

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameters

Called when the selection changes.

Declaration

protected override void OnSelectionChanged(SelectionChangedEventArgs e)

Parameters

Overrides ItemsControlSelector.OnSelectionChanged(SelectionChangedEventArgs)

Called when selection mode changed. Update CanAutocompleteSelectItems property.

Declaration

protected override void OnSelectionModeChanged()

Overrides ItemsControlSelector.OnSelectionModeChanged()

Prepares the specified element to display the specified item.

Declaration

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

Scrolls the into view.

Declaration

public void ScrollIntoView(int index)

Parameters

Implements IListControl.ScrollIntoView(int)

Scrolls the into view.

Declaration

public void ScrollIntoView(object item)

Parameters