Volume Control
Application-specific hotkeys for Windows
VolumeControl.WPF.FilteredTextItemsSource Class Reference

Helper object for creating autocomplete suggestion dropdowns for textboxes. More...

Inheritance diagram for VolumeControl.WPF.FilteredTextItemsSource:
Collaboration diagram for VolumeControl.WPF.FilteredTextItemsSource:

Static Public Attributes

static readonly DependencyProperty ItemsSourceProperty
 The DependencyProperty for ItemsSource. More...
 
static readonly DependencyProperty FilterTextProperty
 The DependencyProperty for FilterText. More...
 
static readonly DependencyProperty StringComparisonProperty
 The DependencyProperty for StringComparison. More...
 
static readonly DependencyProperty FilteredItemsSourceProperty = FilteredItemsSourceReadOnlyPropertyKey.DependencyProperty
 The DependencyProperty for FilteredItemsSource. More...
 

Protected Member Functions

virtual ? IEnumerable< string > GetFilteredItemsSource ()
 Gets the filtered items source enumeration from the current ItemsSource & FilterText. More...
 

Properties

IEnumerable< string > ItemsSource [get, set]
 Gets or sets the source list. More...
 
string FilterText [get, set]
 Gets or sets the string that determines which items are present in the FilteredItemsSource. More...
 
StringComparison StringComparison [get, set]
 Gets or sets the string comparison type to use when matching the FilterText to items. More...
 
IEnumerable< string >?? FilteredItemsSource [get, protected set]
 Gets the filtered list. More...
 

Detailed Description

Helper object for creating autocomplete suggestion dropdowns for textboxes.

Member Function Documentation

◆ GetFilteredItemsSource()

virtual ? IEnumerable<string> VolumeControl.WPF.FilteredTextItemsSource.GetFilteredItemsSource ( )
protectedvirtual

Gets the filtered items source enumeration from the current ItemsSource & FilterText.

Returns
All of the items that start with the current FilterText.

References VolumeControl.WPF.FilteredTextItemsSource.FilterText, VolumeControl.WPF.FilteredTextItemsSource.ItemsSource, and VolumeControl.WPF.FilteredTextItemsSource.StringComparison.

Member Data Documentation

◆ FilteredItemsSourceProperty

readonly DependencyProperty VolumeControl.WPF.FilteredTextItemsSource.FilteredItemsSourceProperty = FilteredItemsSourceReadOnlyPropertyKey.DependencyProperty
static

The DependencyProperty for FilteredItemsSource.

◆ FilterTextProperty

readonly DependencyProperty VolumeControl.WPF.FilteredTextItemsSource.FilterTextProperty
static
Initial value:
= DependencyProperty.Register(
nameof(FilterText),
typeof(string),
typeof(FilteredTextItemsSource),
new PropertyMetadata(string.Empty, OnFilterTextPropertyChanged))
string FilterText
Gets or sets the string that determines which items are present in the FilteredItemsSource.
Definition: FilteredTextItemsSource.cs:54

The DependencyProperty for FilterText.

◆ ItemsSourceProperty

readonly DependencyProperty VolumeControl.WPF.FilteredTextItemsSource.ItemsSourceProperty
static
Initial value:
= DependencyProperty.Register(
nameof(ItemsSource),
typeof(IEnumerable<string>),
typeof(FilteredTextItemsSource),
new PropertyMetadata(null, OnItemsSourcePropertyChanged))
IEnumerable< string > ItemsSource
Gets or sets the source list.
Definition: FilteredTextItemsSource.cs:26

The DependencyProperty for ItemsSource.

Referenced by VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.TextBoxWithCompletionOptions().

◆ StringComparisonProperty

readonly DependencyProperty VolumeControl.WPF.FilteredTextItemsSource.StringComparisonProperty
static
Initial value:
= DependencyProperty.Register(
typeof(FilteredTextItemsSource),
new PropertyMetadata(StringComparison.Ordinal))
StringComparison StringComparison
Gets or sets the string comparison type to use when matching the FilterText to items.
Definition: FilteredTextItemsSource.cs:79

The DependencyProperty for StringComparison.

Referenced by VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.TextBoxWithCompletionOptions().

Property Documentation

◆ FilteredItemsSource

IEnumerable<string>?? VolumeControl.WPF.FilteredTextItemsSource.FilteredItemsSource
getprotected set

Gets the filtered list.

Bind the ItemsSource of your options list to this property.

◆ FilterText

string VolumeControl.WPF.FilteredTextItemsSource.FilterText
getset

Gets or sets the string that determines which items are present in the FilteredItemsSource.

FilteredItemsSource is repopulated when this property is changed.

Referenced by VolumeControl.WPF.FilteredTextItemsSource.GetFilteredItemsSource().

◆ ItemsSource

IEnumerable<string> VolumeControl.WPF.FilteredTextItemsSource.ItemsSource
getset

Gets or sets the source list.

Referenced by VolumeControl.WPF.FilteredTextItemsSource.GetFilteredItemsSource().

◆ StringComparison

StringComparison VolumeControl.WPF.FilteredTextItemsSource.StringComparison
getset

Gets or sets the string comparison type to use when matching the FilterText to items.

Referenced by VolumeControl.WPF.FilteredTextItemsSource.GetFilteredItemsSource().


The documentation for this class was generated from the following file: