Interaction logic for TextBoxWithCompletionOptions.xaml More...

Inheritance diagram for VolumeControl.WPF.Controls.TextBoxWithCompletionOptions:

Collaboration diagram for VolumeControl.WPF.Controls.TextBoxWithCompletionOptions:

Classes
class	CommittedTextEventArgs
	Event arguments for the CommittedTextEventHandler event type. More...

class	SuggestionClickedEventArgs
	Event arguments for the SuggestionClickedEventHandler event type. More...

Public Member Functions
	TextBoxWithCompletionOptions ()
	Creates a new TextBoxWithCompletionOptions instance. More...

delegate void	SuggestionClickedEventHandler (object sender, SuggestionClickedEventArgs e)
	Represents the method that will handle SuggestionClicked events. More...

delegate void	CommittedTextEventHandler (object sender, CommittedTextEventArgs e)
	Represents the method that will handle CommittedText events. More...

Static Public Attributes
static readonly RoutedEvent	SuggestionClickedEvent
	RoutedEvent definition for SuggestionClicked. More...

static readonly RoutedEvent	CommittedTextEvent
	RoutedEvent definition for CommittedText. More...

static readonly RoutedEvent	BackPressedEvent
	RoutedEvent definition for BackPressed. More...

static readonly DependencyProperty	CompletionOptionsSourceProperty
	The DependencyProperty for CompletionOptionsSource. More...

static readonly DependencyProperty	TextProperty
	The DependencyProperty for Text. More...

static readonly DependencyProperty	DefaultTextProperty
	The DependencyProperty for DefaultText. More...

static readonly DependencyProperty	DefaultTextBlockForegroundProperty
	The DependencyProperty for TextBoxForeground. More...

static readonly DependencyProperty	StringComparisonProperty
	The DependencyProperty for StringComparison. More...

static readonly DependencyProperty	BackPressedRequiredModifierKeysProperty
	The DependencyProperty for BackPressedRequiredModifierKeys. More...

static readonly DependencyProperty	TextBoxSelectionBrushProperty
	The DependencyProperty for TextBoxSelectionBrush. More...

static readonly DependencyProperty	TextBoxPaddingProperty
	The DependencyProperty for TextBoxPadding. More...

static readonly DependencyProperty	TextBoxBorderThicknessProperty
	The DependencyProperty for TextBoxBorderThickness. More...

static readonly DependencyProperty	TextBoxBorderBrushProperty
	The DependencyProperty for TextBoxBorderBrush. More...

static readonly DependencyProperty	TextBoxForegroundProperty
	The DependencyProperty for TextBoxForeground. More...

static readonly DependencyProperty	TextBoxBackgroundProperty
	The DependencyProperty for TextBoxBackground. More...

Properties
SuggestionClickedEventHandler	SuggestionClicked
	Occurs when an item in the popup suggestion box is clicked. More...

CommittedTextEventHandler	CommittedText
	Occurs when the Enter key was pressed, indicating that the current text should be committed to whatever is consuming it. More...

RoutedEventHandler	BackPressed
	Occurs when the backspace key is pressed when the textbox is already empty. More...

FilteredTextItemsSource	FilteredItemsSource `[get]`
	Gets the FilteredTextItemsSource object that provides a searchable suggestions list. More...

IEnumerable< string >	CompletionOptionsSource `[get, set]`
	Gets or sets the items source that will be used for completion options. More...

string	Text `[get, set]`
	Gets or sets the text in the textbox. More...

string	DefaultText `[get, set]`
	Gets or sets the default text to show when the textbox is empty. More...

Brush	DefaultTextBlockForeground `[get, set]`

StringComparison	StringComparison `[get, set]`
	Gets or sets the string comparison type to use when matching the FilterText to items. More...

ModifierKeys	BackPressedRequiredModifierKeys `[get, set]`
	Gets or sets the ModifierKeys that must be held when pressing Backspace in order for the BackPressed event to fire. More...

Brush	TextBoxSelectionBrush `[get, set]`

Thickness	TextBoxPadding `[get, set]`

Thickness	TextBoxBorderThickness `[get, set]`

Brush	TextBoxBorderBrush `[get, set]`

Brush	TextBoxForeground `[get, set]`

Brush	TextBoxBackground `[get, set]`

Detailed Description

Interaction logic for TextBoxWithCompletionOptions.xaml

Constructor & Destructor Documentation

◆ TextBoxWithCompletionOptions()

VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.TextBoxWithCompletionOptions ( )

Creates a new TextBoxWithCompletionOptions instance.

References VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.CompletionOptionsSource, VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.FilteredItemsSource, VolumeControl.WPF.FilteredTextItemsSource.ItemsSourceProperty, VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.StringComparison, and VolumeControl.WPF.FilteredTextItemsSource.StringComparisonProperty.

Member Function Documentation

◆ CommittedTextEventHandler()

delegate void VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.CommittedTextEventHandler	(	object	sender,
		CommittedTextEventArgs	e
	)

Represents the method that will handle CommittedText events.

Parameters

sender	The TextBoxWithCompletionOptions instance that triggered the event.
e

◆ SuggestionClickedEventHandler()

delegate void VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.SuggestionClickedEventHandler	(	object	sender,
		SuggestionClickedEventArgs	e
	)

Represents the method that will handle SuggestionClicked events.

Parameters

sender	The TextBoxWithCompletionOptions instance that triggered the event.
e

Member Data Documentation

◆ BackPressedEvent

readonly RoutedEvent VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.BackPressedEvent

static

Initial value:

= EventManager.RegisterRoutedEvent(
            nameof(BackPressed),
            RoutingStrategy.Bubble,
            typeof(RoutedEventHandler),
            typeof(TextBoxWithCompletionOptions))

RoutedEvent definition for BackPressed.

◆ BackPressedRequiredModifierKeysProperty

readonly DependencyProperty VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.BackPressedRequiredModifierKeysProperty

static

Initial value:

= DependencyProperty.Register(
            nameof(BackPressedRequiredModifierKeys),
            typeof(ModifierKeys),
            typeof(TextBoxWithCompletionOptions),
            new PropertyMetadata(ModifierKeys.Control))

The DependencyProperty for BackPressedRequiredModifierKeys.

◆ CommittedTextEvent

readonly RoutedEvent VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.CommittedTextEvent

static

Initial value:

= EventManager.RegisterRoutedEvent(
            nameof(CommittedText),
            RoutingStrategy.Bubble,
            typeof(CommittedTextEventHandler),
            typeof(TextBoxWithCompletionOptions))

RoutedEvent definition for CommittedText.

◆ CompletionOptionsSourceProperty

readonly DependencyProperty VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.CompletionOptionsSourceProperty

static

Initial value:

= DependencyProperty.Register(
            nameof(CompletionOptionsSource),
            typeof(IEnumerable<string>),
            typeof(TextBoxWithCompletionOptions),
            new PropertyMetadata(null))

The DependencyProperty for CompletionOptionsSource.

◆ DefaultTextBlockForegroundProperty

readonly DependencyProperty VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.DefaultTextBlockForegroundProperty

static

Initial value:

= DependencyProperty.Register(
            nameof(DefaultTextBlockForeground),
            typeof(Brush),
            typeof(TextBoxWithCompletionOptions),
            new PropertyMetadata(ForegroundProperty.DefaultMetadata.DefaultValue))

The DependencyProperty for TextBoxForeground.

◆ DefaultTextProperty

readonly DependencyProperty VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.DefaultTextProperty

static

Initial value:

= DependencyProperty.Register(
            nameof(DefaultText),
            typeof(string),
            typeof(TextBoxWithCompletionOptions),
            new PropertyMetadata(string.Empty))

The DependencyProperty for DefaultText.

◆ StringComparisonProperty

readonly DependencyProperty VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.StringComparisonProperty

static

Initial value:

= DependencyProperty.Register(
            nameof(StringComparison),
            typeof(StringComparison),
            typeof(TextBoxWithCompletionOptions),
            new PropertyMetadata(StringComparison.OrdinalIgnoreCase))

The DependencyProperty for StringComparison.

◆ SuggestionClickedEvent

readonly RoutedEvent VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.SuggestionClickedEvent

static

Initial value:

= EventManager.RegisterRoutedEvent(
            nameof(SuggestionClicked),
            RoutingStrategy.Bubble,
            typeof(SuggestionClickedEventHandler),
            typeof(TextBoxWithCompletionOptions))

RoutedEvent definition for SuggestionClicked.

◆ TextBoxBackgroundProperty

readonly DependencyProperty VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.TextBoxBackgroundProperty

static

Initial value:

= DependencyProperty.Register(
            nameof(TextBoxBackground),
            typeof(Brush),
            typeof(TextBoxWithCompletionOptions),
            new PropertyMetadata(BackgroundProperty.DefaultMetadata.DefaultValue))

The DependencyProperty for TextBoxBackground.

◆ TextBoxBorderBrushProperty

readonly DependencyProperty VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.TextBoxBorderBrushProperty

static

Initial value:

= DependencyProperty.Register(
            nameof(TextBoxBorderBrush),
            typeof(Brush),
            typeof(TextBoxWithCompletionOptions),
            new PropertyMetadata(BorderBrushProperty.DefaultMetadata.DefaultValue))

The DependencyProperty for TextBoxBorderBrush.

◆ TextBoxBorderThicknessProperty

readonly DependencyProperty VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.TextBoxBorderThicknessProperty

static

Initial value:

= DependencyProperty.Register(
            nameof(TextBoxBorderThickness),
            typeof(Thickness),
            typeof(TextBoxWithCompletionOptions),
            new PropertyMetadata(BorderThicknessProperty.DefaultMetadata.DefaultValue))

The DependencyProperty for TextBoxBorderThickness.

◆ TextBoxForegroundProperty

readonly DependencyProperty VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.TextBoxForegroundProperty

static

Initial value:

= DependencyProperty.Register(
            nameof(TextBoxForeground),
            typeof(Brush),
            typeof(TextBoxWithCompletionOptions),
            new PropertyMetadata(ForegroundProperty.DefaultMetadata.DefaultValue))

The DependencyProperty for TextBoxForeground.

◆ TextBoxPaddingProperty

readonly DependencyProperty VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.TextBoxPaddingProperty

static

Initial value:

= DependencyProperty.Register(
            nameof(TextBoxPadding),
            typeof(Thickness),
            typeof(TextBoxWithCompletionOptions),
            new PropertyMetadata(PaddingProperty.DefaultMetadata.DefaultValue))

The DependencyProperty for TextBoxPadding.

◆ TextBoxSelectionBrushProperty

readonly DependencyProperty VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.TextBoxSelectionBrushProperty

static

Initial value:

= DependencyProperty.Register(
            nameof(TextBoxSelectionBrush),
            typeof(Brush),
            typeof(TextBoxWithCompletionOptions),
            new PropertyMetadata(System.Windows.Controls.Primitives.TextBoxBase.SelectionBrushProperty.DefaultMetadata.DefaultValue))

The DependencyProperty for TextBoxSelectionBrush.

◆ TextProperty

readonly DependencyProperty VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.TextProperty

static

Initial value:

= DependencyProperty.Register(
            nameof(Text),
            typeof(string),
            typeof(TextBoxWithCompletionOptions),
            new PropertyMetadata(string.Empty, OnTextPropertyChanged))

The DependencyProperty for Text.

Property Documentation

◆ BackPressed

RoutedEventHandler VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.BackPressed

addremove

Occurs when the backspace key is pressed when the textbox is already empty.

◆ BackPressedRequiredModifierKeys

ModifierKeys VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.BackPressedRequiredModifierKeys

getset

Gets or sets the ModifierKeys that must be held when pressing Backspace in order for the BackPressed event to fire.

◆ CommittedText

CommittedTextEventHandler VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.CommittedText

addremove

Occurs when the Enter key was pressed, indicating that the current text should be committed to whatever is consuming it.

◆ CompletionOptionsSource

IEnumerable<string> VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.CompletionOptionsSource

getset

Gets or sets the items source that will be used for completion options.

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

◆ DefaultText

string VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.DefaultText

getset

Gets or sets the default text to show when the textbox is empty.

◆ FilteredItemsSource

FilteredTextItemsSource VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.FilteredItemsSource

getprotected

Gets the FilteredTextItemsSource object that provides a searchable suggestions list.

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

◆ StringComparison

StringComparison VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.StringComparison

getset

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

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

◆ SuggestionClicked

SuggestionClickedEventHandler VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.SuggestionClicked

addremove

Occurs when an item in the popup suggestion box is clicked.

◆ Text

string VolumeControl.WPF.Controls.TextBoxWithCompletionOptions.Text

getset

Gets or sets the text in the textbox.

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

/home/runner/work/volume-control/volume-control/VolumeControl.WPF/Controls/TextBoxWithCompletionOptions.xaml.cs

Classes

Public Member Functions

Static Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TextBoxWithCompletionOptions()

Member Function Documentation

◆ CommittedTextEventHandler()

◆ SuggestionClickedEventHandler()

Member Data Documentation

◆ BackPressedEvent

◆ BackPressedRequiredModifierKeysProperty

◆ CommittedTextEvent

◆ CompletionOptionsSourceProperty

◆ DefaultTextBlockForegroundProperty

◆ DefaultTextProperty

◆ StringComparisonProperty

◆ SuggestionClickedEvent

◆ TextBoxBackgroundProperty

◆ TextBoxBorderBrushProperty

◆ TextBoxBorderThicknessProperty

◆ TextBoxForegroundProperty

◆ TextBoxPaddingProperty

◆ TextBoxSelectionBrushProperty

◆ TextProperty

Property Documentation

◆ BackPressed

◆ BackPressedRequiredModifierKeys

◆ CommittedText

◆ CompletionOptionsSource

◆ DefaultText

◆ FilteredItemsSource

◆ StringComparison

◆ SuggestionClicked

◆ Text