C# Class System.Windows.Controls.AutoCompleteBox

Inheritance: Control, IUpdateVisualState

Show file Open project: Warewolf-ESB/Warewolf Class Usage Examples

Public Properties

Property	Type	Description
DropDownClosedEvent	RoutedEvent
DropDownClosingEvent	RoutedEvent
DropDownOpenedEvent	RoutedEvent
DropDownOpeningEvent	RoutedEvent
FilterModeProperty	DependencyProperty
IsDropDownOpenProperty	DependencyProperty
IsTextCompletionEnabledProperty	DependencyProperty
ItemContainerStyleProperty	DependencyProperty
ItemFilterProperty	DependencyProperty
ItemTemplateProperty	DependencyProperty
ItemsSourceProperty	DependencyProperty
MaxDropDownHeightProperty	DependencyProperty
MinimumPopulateDelayProperty	DependencyProperty
MinimumPrefixLengthProperty	DependencyProperty
PopulatedEvent	RoutedEvent
PopulatingEvent	RoutedEvent
SearchTextProperty	DependencyProperty
SelectedItemProperty	DependencyProperty
SelectionChangedEvent	RoutedEvent
TextBoxStyleProperty	DependencyProperty
TextChangedEvent	RoutedEvent
TextFilterProperty	DependencyProperty
TextProperty	DependencyProperty

Private Properties

Property	Type	Description
AutoCompleteBox	System.Collections
ClearView	void
CloseDropDown	void
ClosingDropDown	void
ControlIsEnabledChanged	void
DropDownPopupClosed	void
FocusChanged	void
FormatValue	string
GetSelectionAdapterPart	ISelectionAdapter
IUpdateVisualState	void
ItemsSourceCollectionChanged	void
OnAdapterSelectionCanceled	void
OnAdapterSelectionChanged	void
OnAdapterSelectionComplete	void
OnDropDownFocusChanged	void
OnDropDownPopupUpdateVisualStates	void
OnFilterModePropertyChanged	void
OnIsDropDownOpenPropertyChanged	void
OnItemFilterPropertyChanged	void
OnItemsSourceChanged	void
OnItemsSourcePropertyChanged	void
OnMaxDropDownHeightChanged	void
OnMaxDropDownHeightPropertyChanged	void
OnMinimumPopulateDelayPropertyChanged	void
OnMinimumPrefixLengthPropertyChanged	void
OnSearchTextPropertyChanged	void
OnSelectedItemChanged	void
OnSelectedItemPropertyChanged	void
OnTextBoxPreviewKeyDown	void
OnTextBoxSelectionChanged	void
OnTextBoxTextChanged	void
OnTextPropertyChanged	void
OpenDropDown	void
OpeningDropDown	void
PopulateDropDown	void
RaiseExpandCollapseAutomationEvent	void
RefreshView	void
TextUpdated	void
TryGetMatch	object
UpdateTextCompletion	void
UpdateTextValue	void
UpdateTextValue	void
UpdateVisualState	void

Public Methods

Method	Description
OnApplyTemplate ( ) : void	Builds the visual tree for the T:System.Windows.Controls.AutoCompleteBox control when a new template is applied.
PopulateComplete ( ) : void	Notifies the T:System.Windows.Controls.AutoCompleteBox that the P:System.Windows.Controls.AutoCompleteBox.ItemsSource property has been set and the data can be filtered to provide possible matches in the drop-down. Call this method when you are providing custom population of the drop-down portion of the AutoCompleteBox, to signal the control that you are done with the population process. Typically, you use PopulateComplete when the population process is a long-running process and you want to cancel built-in filtering of the ItemsSource items. In this case, you can handle the Populated event and set PopulatingEventArgs.Cancel to true. When the long-running process has completed you call PopulateComplete to indicate the drop-down is populated.

Protected Methods

Method	Description
ArrangeOverride ( Size finalSize ) : Size	Arranges and sizes the T:System.Windows.Controls.AutoCompleteBox control and its contents.
FormatValue ( object value ) : string	Converts the specified object to a string by using the P:System.Windows.Data.Binding.Converter and P:System.Windows.Data.Binding.ConverterCulture values of the binding object specified by the P:System.Windows.Controls.AutoCompleteBox.ValueMemberBinding property. Override this method to provide a custom string conversion.
HasFocus ( ) : bool	Determines whether the text box or drop-down portion of the T:System.Windows.Controls.AutoCompleteBox control has focus.
OnCreateAutomationPeer ( ) : System.Windows.Automation.Peers.AutomationPeer	Creates an T:System.Windows.Automation.Peers.AutoCompleteBoxAutomationPeer
OnDropDownClosed ( RoutedPropertyChangedEventArgs e ) : void	Raises the E:System.Windows.Controls.AutoCompleteBox.DropDownClosed event.
OnDropDownClosing ( RoutedPropertyChangingEventArgs e ) : void	Raises the E:System.Windows.Controls.AutoCompleteBox.DropDownClosing event.
OnDropDownOpened ( RoutedPropertyChangedEventArgs e ) : void	Raises the E:System.Windows.Controls.AutoCompleteBox.DropDownOpened event.
OnDropDownOpening ( RoutedPropertyChangingEventArgs e ) : void	Raises the E:System.Windows.Controls.AutoCompleteBox.DropDownOpening event.
OnGotFocus ( RoutedEventArgs e ) : void	Provides handling for the E:System.Windows.UIElement.GotFocus event.
OnIsKeyboardFocusWithinChanged ( DependencyPropertyChangedEventArgs e ) : void	Handles change of keyboard focus, which is treated differently than control focus
OnKeyDown ( System.Windows.Input.KeyEventArgs e ) : void	Provides handling for the E:System.Windows.UIElement.KeyDown event.
OnLostFocus ( RoutedEventArgs e ) : void	Provides handling for the E:System.Windows.UIElement.LostFocus event.
OnPopulated ( PopulatedEventArgs e ) : void	Raises the E:System.Windows.Controls.AutoCompleteBox.Populated event.
OnPopulating ( PopulatingEventArgs e ) : void	Raises the E:System.Windows.Controls.AutoCompleteBox.Populating event.
OnSelectionChanged ( System.Windows.Controls.SelectionChangedEventArgs e ) : void	Raises the E:System.Windows.Controls.AutoCompleteBox.SelectionChanged event.
OnTextChanged ( RoutedEventArgs e ) : void	Raises the E:System.Windows.Controls.AutoCompleteBox.TextChanged event.

Private Methods

Method	Description
AutoCompleteBox ( ) : System.Collections	Initializes the static members of the T:System.Windows.Controls.AutoCompleteBox class.
ClearView ( ) : void	A simple helper method to clear the view and ensure that a view object is always present and not null.
CloseDropDown ( bool oldValue, bool newValue ) : void	Private method that directly closes the popup, flips the Checked value, and then fires the Closed event.
ClosingDropDown ( bool oldValue ) : void	Begin closing the drop-down.
ControlIsEnabledChanged ( object sender, DependencyPropertyChangedEventArgs e ) : void	Handle the change of the IsEnabled property.
DropDownPopupClosed ( object sender, EventArgs e ) : void	Connects to the DropDownPopup Closed event.
FocusChanged ( bool hasFocus ) : void	Handles the FocusChanged event.
FormatValue ( object value, bool clearDataContext ) : string	Formats an Item for text comparisons based on Converter and ConverterCulture properties.
GetSelectionAdapterPart ( ) : ISelectionAdapter
IUpdateVisualState ( bool useTransitions ) : void	Update the visual state of the control.
ItemsSourceCollectionChanged ( NotifyCollectionChangedEventArgs e ) : void	Method that handles the ObservableCollection.CollectionChanged event for the ItemsSource property.
OnAdapterSelectionCanceled ( object sender, RoutedEventArgs e ) : void	Handles the Cancel event on the selection adapter.
OnAdapterSelectionChanged ( object sender, System.Windows.Controls.SelectionChangedEventArgs e ) : void	Handles the SelectionChanged event of the selection adapter.
OnAdapterSelectionComplete ( object sender, RoutedEventArgs e ) : void	Handles the Commit event on the selection adapter.
OnDropDownFocusChanged ( object sender, EventArgs e ) : void	Allows the popup wrapper to fire the FocusChanged event.
OnDropDownPopupUpdateVisualStates ( object sender, EventArgs e ) : void	Allows the popup wrapper to fire visual state change events.
OnFilterModePropertyChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void
OnIsDropDownOpenPropertyChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void	IsDropDownOpenProperty property changed handler.
OnItemFilterPropertyChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void	ItemFilterProperty property changed handler.
OnItemsSourceChanged ( IEnumerable oldValue, IEnumerable newValue ) : void
OnItemsSourcePropertyChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void	ItemsSourceProperty property changed handler.
OnMaxDropDownHeightChanged ( double newValue ) : void
OnMaxDropDownHeightPropertyChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void
OnMinimumPopulateDelayPropertyChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void
OnMinimumPrefixLengthPropertyChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void
OnSearchTextPropertyChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void	OnSearchTextProperty property changed handler.
OnSelectedItemChanged ( object newItem ) : void	Called when the selected item is changed, updates the text value that is displayed in the text box part.
OnSelectedItemPropertyChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void	SelectedItemProperty property changed handler. Fires the SelectionChanged event. The event data will contain any non-null removed items and non-null additions.
OnTextBoxPreviewKeyDown ( object sender, System.Windows.Input.KeyEventArgs e ) : void	Handles the PreviewKeyDown event on the TextBox for WPF. This method is not implemented for Silverlight.
OnTextBoxSelectionChanged ( object sender, RoutedEventArgs e ) : void	When selection changes, save the location of the selection start.
OnTextBoxTextChanged ( object sender, System.Windows.Controls.TextChangedEventArgs e ) : void	Handle the TextChanged event that is directly attached to the TextBox part. This ensures that only user initiated actions will result in an AutoCompleteBox suggestion and operation.
OnTextPropertyChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void	TextProperty property changed handler.
OpenDropDown ( bool oldValue, bool newValue ) : void	Private method that directly opens the popup, checks the expander button, and then fires the Opened event.
OpeningDropDown ( bool oldValue ) : void	Begin opening the drop down by firing cancelable events, opening the drop-down or reverting, depending on the event argument values.
PopulateDropDown ( object sender, EventArgs e ) : void	Handles the timer tick when using a populate delay.
RaiseExpandCollapseAutomationEvent ( bool oldValue, bool newValue ) : void	Raise an expand/collapse event through the automation peer.
RefreshView ( ) : void	Walks through the items enumeration. Performance is not going to be perfect with the current implementation.
TextUpdated ( string newText, bool userInitiated ) : void	Handle the update of the text for the control from any source, including the TextBox part and the Text dependency property.
TryGetMatch ( string searchText, ObservableCollection	Attempts to look through the view and locate the specific exact text match.
UpdateTextCompletion ( bool userInitiated ) : void	Performs text completion, if enabled, and a lookup on the underlying item values for an exact match. Will update the SelectedItem value.
UpdateTextValue ( string value ) : void	Updates both the text box value and underlying text dependency property value if and when they change. Automatically fires the text changed events when there is a change.
UpdateTextValue ( string value, bool userInitiated ) : void	Updates both the text box value and underlying text dependency property value if and when they change. Automatically fires the text changed events when there is a change.
UpdateVisualState ( bool useTransitions ) : void	Update the current visual state of the button.

Method Details

ArrangeOverride() protected method

Arranges and sizes the T:System.Windows.Controls.AutoCompleteBox control and its contents.

protected ArrangeOverride ( Size finalSize ) : Size
finalSize	Size	The size allowed for the /// control.
return	Size

FormatValue() protected method

Converts the specified object to a string by using the P:System.Windows.Data.Binding.Converter and P:System.Windows.Data.Binding.ConverterCulture values of the binding object specified by the P:System.Windows.Controls.AutoCompleteBox.ValueMemberBinding property.

Override this method to provide a custom string conversion.

protected FormatValue ( object value ) : string
value	object	The object to format as a string.
return	string

HasFocus() protected method

Determines whether the text box or drop-down portion of the T:System.Windows.Controls.AutoCompleteBox control has focus.

protected HasFocus ( ) : bool
return	bool

OnApplyTemplate() public method

Builds the visual tree for the T:System.Windows.Controls.AutoCompleteBox control when a new template is applied.

public OnApplyTemplate ( ) : void
return	void

OnCreateAutomationPeer() protected method

Creates an T:System.Windows.Automation.Peers.AutoCompleteBoxAutomationPeer

protected OnCreateAutomationPeer ( ) : System.Windows.Automation.Peers.AutomationPeer
return	System.Windows.Automation.Peers.AutomationPeer

OnDropDownClosed() protected method

Raises the E:System.Windows.Controls.AutoCompleteBox.DropDownClosed event.

protected OnDropDownClosed ( RoutedPropertyChangedEventArgs e ) : void
e	RoutedPropertyChangedEventArgs	A /// /// which contains the event data.
return	void

OnDropDownClosing() protected method

Raises the E:System.Windows.Controls.AutoCompleteBox.DropDownClosing event.

protected OnDropDownClosing ( RoutedPropertyChangingEventArgs e ) : void
e	RoutedPropertyChangingEventArgs	A /// /// that contains the event data.
return	void

OnDropDownOpened() protected method

Raises the E:System.Windows.Controls.AutoCompleteBox.DropDownOpened event.

protected OnDropDownOpened ( RoutedPropertyChangedEventArgs e ) : void
e	RoutedPropertyChangedEventArgs	A /// /// that contains the event data.
return	void

OnDropDownOpening() protected method

Raises the E:System.Windows.Controls.AutoCompleteBox.DropDownOpening event.

protected OnDropDownOpening ( RoutedPropertyChangingEventArgs e ) : void
e	RoutedPropertyChangingEventArgs	A /// /// that contains the event data.
return	void

OnGotFocus() protected method

Provides handling for the E:System.Windows.UIElement.GotFocus event.

protected OnGotFocus ( RoutedEventArgs e ) : void
e	RoutedEventArgs	A /// that contains the event data.
return	void

OnIsKeyboardFocusWithinChanged() protected method

Handles change of keyboard focus, which is treated differently than control focus

protected OnIsKeyboardFocusWithinChanged ( DependencyPropertyChangedEventArgs e ) : void
e	DependencyPropertyChangedEventArgs
return	void

OnKeyDown() protected method

Provides handling for the E:System.Windows.UIElement.KeyDown event.

protected OnKeyDown ( System.Windows.Input.KeyEventArgs e ) : void
e	System.Windows.Input.KeyEventArgs	A /// that contains the event data.
return	void

OnLostFocus() protected method

Provides handling for the E:System.Windows.UIElement.LostFocus event.

protected OnLostFocus ( RoutedEventArgs e ) : void
e	RoutedEventArgs	A /// that contains the event data.
return	void

OnPopulated() protected method

Raises the E:System.Windows.Controls.AutoCompleteBox.Populated event.

protected OnPopulated ( PopulatedEventArgs e ) : void
e	PopulatedEventArgs	A /// /// that contains the event data.
return	void

OnPopulating() protected method

Raises the E:System.Windows.Controls.AutoCompleteBox.Populating event.

protected OnPopulating ( PopulatingEventArgs e ) : void
e	PopulatingEventArgs	A /// that /// contains the event data.
return	void

OnSelectionChanged() protected method

Raises the E:System.Windows.Controls.AutoCompleteBox.SelectionChanged event.

protected OnSelectionChanged ( System.Windows.Controls.SelectionChangedEventArgs e ) : void
e	System.Windows.Controls.SelectionChangedEventArgs	A /// /// that contains the event data.
return	void

OnTextChanged() protected method

Raises the E:System.Windows.Controls.AutoCompleteBox.TextChanged event.

protected OnTextChanged ( RoutedEventArgs e ) : void
e	RoutedEventArgs	A /// that contains the event data.
return	void

PopulateComplete() public method

Notifies the T:System.Windows.Controls.AutoCompleteBox that the P:System.Windows.Controls.AutoCompleteBox.ItemsSource property has been set and the data can be filtered to provide possible matches in the drop-down.

Call this method when you are providing custom population of the drop-down portion of the AutoCompleteBox, to signal the control that you are done with the population process. Typically, you use PopulateComplete when the population process is a long-running process and you want to cancel built-in filtering of the ItemsSource items. In this case, you can handle the Populated event and set PopulatingEventArgs.Cancel to true. When the long-running process has completed you call PopulateComplete to indicate the drop-down is populated.

public PopulateComplete ( ) : void
return	void

Property Details

DropDownClosedEvent public static property

public static RoutedEvent DropDownClosedEvent
return	RoutedEvent

DropDownClosingEvent public static property

public static RoutedEvent DropDownClosingEvent
return	RoutedEvent

DropDownOpenedEvent public static property

public static RoutedEvent DropDownOpenedEvent
return	RoutedEvent

DropDownOpeningEvent public static property

public static RoutedEvent DropDownOpeningEvent
return	RoutedEvent

FilterModeProperty public static property

Gets the identifier for the P:System.Windows.Controls.AutoCompleteBox.FilterMode dependency property.

public static DependencyProperty FilterModeProperty
return	DependencyProperty

IsDropDownOpenProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.IsDropDownOpen dependency property.

public static DependencyProperty IsDropDownOpenProperty
return	DependencyProperty

IsTextCompletionEnabledProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.IsTextCompletionEnabled dependency property.

public static DependencyProperty IsTextCompletionEnabledProperty
return	DependencyProperty

ItemContainerStyleProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.ItemContainerStyle dependency property.

public static DependencyProperty ItemContainerStyleProperty
return	DependencyProperty

ItemFilterProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.ItemFilter dependency property.

public static DependencyProperty ItemFilterProperty
return	DependencyProperty

ItemTemplateProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.ItemTemplate dependency property.

public static DependencyProperty ItemTemplateProperty
return	DependencyProperty

ItemsSourceProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.ItemsSource dependency property.

public static DependencyProperty ItemsSourceProperty
return	DependencyProperty

MaxDropDownHeightProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.MaxDropDownHeight dependency property.

public static DependencyProperty MaxDropDownHeightProperty
return	DependencyProperty

MinimumPopulateDelayProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.MinimumPopulateDelay dependency property.

public static DependencyProperty MinimumPopulateDelayProperty
return	DependencyProperty

MinimumPrefixLengthProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.MinimumPrefixLength dependency property.

public static DependencyProperty MinimumPrefixLengthProperty
return	DependencyProperty

PopulatedEvent public static property

public static RoutedEvent PopulatedEvent
return	RoutedEvent

PopulatingEvent public static property

public static RoutedEvent PopulatingEvent
return	RoutedEvent

SearchTextProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.SearchText dependency property.

public static DependencyProperty SearchTextProperty
return	DependencyProperty

SelectedItemProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.SelectedItem dependency property.

public static DependencyProperty SelectedItemProperty
return	DependencyProperty

SelectionChangedEvent public static property

public static RoutedEvent SelectionChangedEvent
return	RoutedEvent

TextBoxStyleProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.TextBoxStyle dependency property.

public static DependencyProperty TextBoxStyleProperty
return	DependencyProperty

TextChangedEvent public static property

public static RoutedEvent TextChangedEvent
return	RoutedEvent

TextFilterProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.TextFilter dependency property.

public static DependencyProperty TextFilterProperty
return	DependencyProperty

TextProperty public static property

Identifies the P:System.Windows.Controls.AutoCompleteBox.Text dependency property.

public static DependencyProperty TextProperty
return	DependencyProperty