Skip to end of metadata
Go to start of metadata

Remarks

UXDataComboBox is used to query and select a record from relatively large data set. Unlike UXComboBox, UXDataComboBox does not have a collection of items bound initially. You need to input the query to UXDataComboBox and handle the query using the QueryDescriptor and MVVM pattern. To learn more about the QueryDescriptor, see Query Descriptor Overview. For more information about MVVM pattern, see MVVM Pattern Overview.

To learn more about UXDataComboBox see UXDataComboBox Overview.

Example

The following code shows how to use UXDataComboBox to query and select a record.

View
ViewModel

Notice that you only need to bind the FilterDescriptors in your XAML and handle the QueryChanged in your ViewModel. The UXDataComboBox will pass the filter descriptors based on FilterMemberPathFilterOperator and user's input query.

If the FilterMemberPath property is not specified, UXDataComboBox will use DisplayMemberPath for the filtering purpose.

Working with AutoLoadMoreData Property

This feature enables UXPageableComboBox to automatically load more data when scroll reaches the bottom. To enable this feature, set AutoLoadMoreData property to True.

Working with CanUserPage Property, FilterDescriptors Property, FilterMemberPath Property and SortDescriptors Property

UXPageableComboBox provides a flexible way to display a collection of data in a single or multiple columns layout. Similar to UXDataComboBox, you need to input the query into UXPageableComboBox and handle the query using the QueryDescriptor component model. The control is designed with MVVM-ready architecture so that you can write the user interaction code entirely in the ViewModel including the implementation for paging feature.

You can use the PageSize property to determine the number of item per page in your UXPageableComboBox or disable the paging feature by setting the CanUserPage property to False.

Notice that you only need to bind the FilterDescriptors in the XAML and handle the QueryChanged in your ViewModelUXPageableComboBox will automatically provide the filter descriptors based on FilterMemberPath, FilterOperator and user's input query.

When the PageDescriptor is larger than 0, this indicates that the control is requesting more data to be retrieved. As seen in the code above, you should add the new items to the existing collection instead of assigning the result to the initial collection property. This approach allows incremental data loading which significantly improves performance even for very large data scenario.

You can use the PageSize property to determine the number of item per page in your UXPageableComboBox or disable the paging feature by setting the CanUserPage property to False.

If the FilterMemberPath property is not specified, UXDataComboBox will use DisplayMemberPath for the filtering purpose.
The following code shows how to use UXPageableComboBox, how to use FilterDescriptors on UXPageableComboBox and how to customize page size on UXPageableComboBox..

XAML
C#

Working with CanUserSort Property

UXPageableComboBox columns also comes with sorting capability. This feature can be enabled by set the CanUserSort property to True. If you prefer to disable sorting on certain columns, set the CanUserSort property of the column to False.

Working with ColumnHeaderVisibility Property

By default, column header will be displayed in multiple column mode. But if you want to hide the column header, simply set the ColumnHeaderVisibility property to Collapsed.

Working with Columns Property

UXPageableComboBox control has a great feature to display records in multiple columns. Similar to UXGridView, you must specify the columns you want to use for hosting the content. The built-in column types include a text-image column and template column.

The following code will explain how to implement it on UXPageableComboBox control.

XAML

Working with DescriptionMemberPath Property, DescriptionText Property and DescriptionVisibility Property

DescriptionText is represents the additional information about the selected item which is displayed at the right side of the UXPageableComboBox. It will be displayed when the UXPageableComboBox is not focused. This feature can be enabled by set the DescriptionVisibility property to Visible and remember to bind the member path of the data source to the DescriptionMemberPath property.

Definition

public class UXDataComboBox : UXComboBox, ISupportDataLoading

Summary

The following table summarizes the members exposed in this class.

Public Constructors

UXDataComboBox Constructor()Initializes a new instance of the UXDataComboBox class.

Public Properties

AutoLoadMoreDataGets or sets a value that indicates whether the control should automatically load more data when the vertical scroll offset reached its bottom edge.
AutoShowResultBoxGets or sets a value indicating whether the result box should be automatically displayed when the query text is changed.
AutoSynchronizeDropdownGets or sets a value that determine whether UXDataComboBox should synchronize the query text with the existing text when drop down is open.
BusyModeGets or sets the busy mode.
BusyTemplateGets or sets the busy template.
BusyTextGets or sets the busy text.
CanUserPageGets or sets a value indicating whether the search result can be paged.
CanUserSortGets or sets a value indicating whether the search result can be sorted.
ColumnHeaderStyleGets or sets the style that is used when rendering the column headers.
ColumnHeaderStyleSelectorGets or sets the style selector that is used when rendering the column headers.
ColumnHeaderTemplateSelectorGets or sets the template selector that is used when rendering the column headers.
ColumnHeaderVisibilityGets or sets a value that indicates the visibility of column header.
ColumnHeaderVisibilityCalculatedGets or sets the column header visibility calculated text.
ColumnsGets or sets the columns that going to be displayed.
DescriptionForegroundGets or sets the description foreground.
DescriptionMaxWidthGets or sets the description max width.
DescriptionMemberPathGets or sets the description member path.
DescriptionStyleGets or sets the description style.
DescriptionTextGets or sets the description text.
DescriptionVisibilityGets or sets the description visibility.
FilterDescriptorsGets or sets the descriptor object that encapsulates the filtering related information.
FilterMemberPathGets or sets member path used in the filter descriptor.
FilterOperatorGets or sets filter operator used in the filter descriptor.
HeaderAndRowSeparatorBrushGets or sets the header and row separator brush.
IsSearchingGets or sets a value that indicates whether the UXDataComboBox is currently searching.
ItemsRetrievedTextGets or sets the text when query return results.
LoadDataWhenEmptyGets or sets a value indicating whether data combo box should load data when the drop down is opened and the text is empty.
MaxLengthGets or sets the maximum character available for text input.
NoResultTemplateGets or sets the no result template.
NoResultTextGets or sets the text when query return no results.
PageDescriptorGets or sets the descriptor object that encapsulates the paging related information.
PageSizeGets or sets the page size.
QueryLatencyGets or sets the latency in seconds before query text is updated.
QueryTextGets or sets the current query text.
ResourceOverrideGets or sets the individual resource object to override the existing localized resource.
SearchCommandGets or sets the SearchCommand to invoke when this button is clicked.
SearchCommandCannotExecuteGets or sets the UI behavior when the associated SearchCommand cannot be executed.
SearchCommandParameterGets or sets the parameter to pass to the SearchCommand property.
SearchCommandTargetGets or sets the element on which to raise the specified SearchCommand.
SearchResultGets or sets the search result collection to be displayed in the dropdown.
ShowResultBoxOnEmptyDataGets or sets a value indicating whether data combo box should open the drop down when no data retrieved.
SortDescriptorsGets or sets the descriptor object that encapsulates the sorting related information.
StatusBarTextGets or sets the status text.
StatusBarVisibilityGets or sets the status bar visibility.
VerticalLineBrushGets or sets the header and row separator brush.
VerticalLineVisibilityGets or sets the vertical line visibility.

Protected Properties

ProductProduct Info.

Fields

AutoLoadMoreDataPropertyIdentifies the AutoLoadMoreData dependency property.
AutoShowResultBoxPropertyIdentifies the AutoShowResultBox dependency property.
AutoSynchronizeDropdownPropertyIdentifies the AutoSynchronizeDropdown dependency property.
BusyModePropertyIdentifies the BusyMode dependency property.
BusyTextPropertyIdentifies the BusyText dependency property.
CanUserPagePropertyIdentifies the CanUserPage dependency property.
CanUserSortPropertyIdentifies the CanUserSort dependency property.
ColumnHeaderStylePropertyIdentifies the ColumnHeaderStyle dependency property.
ColumnHeaderStyleSelectorPropertyIdentifies the ColumnHeaderStyleSelector dependency property.
ColumnHeaderTemplateSelectorPropertyIdentifies the ColumnHeaderTemplateSelector dependency property.
ColumnHeaderVisibilityCalculatedPropertyIdentifies the ColumnHeaderVisibilityCalculated dependency property.
ColumnHeaderVisibilityPropertyIdentifies the ColumnHeaderVisibility dependency property.
ColumnsPropertyIdentifies the Columns dependency property.
DescriptionForegroundPropertyIdentifies the DescriptionForeground dependency property.
DescriptionMaxWidthPropertyIdentifies the DescriptionMaxWidth dependency property.
DescriptionMemberPathPropertyIdentifies the DescriptionMemberPath dependency property.
DescriptionStylePropertyIdentifies the DescriptionStyle dependency property.
DescriptionTextPropertyIdentifies the DescriptionText dependency property.
DescriptionVisibilityPropertyIdentifies the DescriptionVisibility dependency property.
FilterDescriptorsPropertyIdentifies the FilterDescriptors dependency property.
FilterMemberPathPropertyIdentifies the FilterMemberPath dependency property.
FilterOperatorPropertyIdentifies the FilterOperator dependency property.
HeaderAndRowSeparatorBrushPropertyIdentifies the HeaderAndRowSeparatorBrush dependency property.
IsSearchingPropertyIdentifies the IsSearching dependency property.
ItemsRetrievedTextPropertyIdentifies the ItemsRetrieved dependency property.
LoadDataWhenEmptyPropertyIdentifies the LoadDataWhenEmpty dependency property.
MaxLengthPropertyIdentifies the MaxLength dependency property.
NoResultTextPropertyIdentifies the NoResultText dependency property.
PageDescriptorPropertyIdentifies the SortDescriptors dependency property.
PageSizePropertyIdentifies the PageSize dependency property.
QueryLatencyPropertyIdentifies the QueryLatency dependency property.
QueryTextChangedEventIdentifies the QueryTextChanged routed event.
QueryTextPropertyIdentifies the QueryText dependency property.
ResourceOverridePropertyIdentifies the ResourceOverride dependency property.
SearchCommandCannotExecutePropertyIdentifies the SearchCommandCannotExecute dependency property.
SearchCommandParameterPropertyIdentifies the SearchCommandParameter dependency property.
SearchCommandPropertyIdentifies the Command dependency property.
SearchCommandTargetPropertyIdentifies the SearchCommandTarget dependency property.
SearchResultPropertyIdentifies the SearchResult dependency property.
ShowResultBoxOnEmptyDataPropertyIdentifies the ShowResultBoxOnEmptyData dependency property.
SortDescriptorsPropertyIdentifies the SortDescriptors dependency property.
StatusBarTextPropertyIdentifies the StatusText dependency property.
StatusBarVisibilityPropertyIdentifies the StatusBarVisibility dependency property.
VerticalLineBrushPropertyIdentifies the VerticalLineBrush dependency property.
VerticalLineVisibilityPropertyIdentifies the VerticalLineVisibility dependency property.

Public Methods

AttachEventHandlers()Attach built-in event handlers to control templates. Call this method if necessary.
DetachedEventHandlers()Detach built-in event handlers from control templates. Call this method if necessary.
Dispose()Called when this object is disposed.
InitializeTemplates()Initializes control templates.
OnApplyTemplate()Builds the visual tree for the ISItemsControl when a new template is applied.
ResetAllSortState(UXDataComboBoxColumn)Reset all column sort state, except the column that specified
ResetSortDescriptors()Reset all sort descriptors
SelectValue(int) 

Protected Methods

GetContainerForItemOverride()Creates or identifies the element that is used to display the given item.
IsItemItsOwnContainerOverride(object)Determines if the specified item is (or is eligible to be) its own container.
Menu_Closed(object, ISRoutedEventArgs)On drop down menu closed.
Menu_Opened(object, ISRoutedEventArgs)On drop down menu opened.
OnAfterSelectedItemChanged(object) 
OnColumnsCollectionChanged(object, NotifyCollectionChangedEventArgs)Called when the value of the Columns collection is changed.
OnGotFocus(RoutedEventArgs) 
OnIsDropDownOpenChanged(DependencyPropertyChangedEventArgs)Called when the value of IsDropDownOpen property changes.
OnItemsChanged(NotifyCollectionChangedEventArgs)Called when the value of the ItemsControl.Items property changes.
OnItemsSourceChanged(IEnumerable, IEnumerable)Called when the ItemsSource changes.
OnKeyDown(KeyEventArgs) 
OnLostFocus(RoutedEventArgs) 
OnMouseLeftButtonDown(MouseButtonEventArgs)Called before the MouseLeftButtonDown event occurs.
OnSelectedItemChanged(object, object)Called when the value of the SelectedItem property changes.
OnTextChanged(string, string)Called when the value of Text property changes.

Events

DataLoaded 
DataLoading 
QueryTextChangedOccurs when the selection of a ISelection changes.

Public Constructors

public UXDataComboBox()

Initializes a new instance of the UXDataComboBox class.

Public Properties

public bool AutoLoadMoreData { get; set; }

Gets or sets a value that indicates whether the control should automatically load more data when the vertical scroll offset reached its bottom edge.

public bool AutoShowResultBox { get; set; }

Gets or sets a value indicating whether the result box should be automatically displayed when the query text is changed.

Remarks

UXDataComboBox has several user experience aspects that you can customize, such as when to display the result box and when to show the busy text/template. Using the default settings, UXDataComboBox will not open the result box immediately when users type in a query text. Instead, it waits until the search result becomes available and then display it along with the result box. Users will then select an item from the available results. By setting the AutoShowResultBox property to True, UXDataComboBox immediately opens the result box as you type into the text box. While waiting for the search result, the search box displays the UXDataComboBox or UXDataComboBox which indicates that the searching is in progress. You can also determine the behavior of the UXDataComboBox or UXDataComboBox by customizing the UXDataComboBox property. This property determines when the UXDataComboBox or UXDataComboBox should be shown. If you set the UXDataComboBox to First, the search box shows the UXDataComboBox or UXDataComboBox only once during the first search until the search is reset. In contrast, if you set the UXDataComboBox to Always, the search box shows the UXDataComboBox or UXDataComboBox whenever searching is in progress. For more information about user experience features in ClientUI controls, see User Experiences Overview.

 

public bool AutoSynchronizeDropdown { get; set; }

Gets or sets a value that determine whether UXDataComboBox should synchronize the query text with the existing text when drop down is open.

public BusyMode BusyMode { get; set; }

Gets or sets the busy mode.

Remarks

UXDataComboBox has several user experience aspects that you can customize, such as when to display the result box and when to show the busy text/template. Using the default settings, UXDataComboBox will not open the result box immediately when users type in a query text. Instead, it waits until the search result becomes available and then display it along with the result box. Users will then select an item from the available results. By setting the UXDataComboBox property to True, UXDataComboBox immediately opens the result box as you type into the text box. While waiting for the search result, the search box displays the UXDataComboBox or UXDataComboBox which indicates that the searching is in progress. You can also determine the behavior of the UXDataComboBox or UXDataComboBox by customizing the BusyMode property. This property determines when the UXDataComboBox or UXDataComboBox should be shown. If you set the BusyMode to First, the search box shows the UXDataComboBox or UXDataComboBox only once during the first search until the search is reset. In contrast, if you set the BusyMode to Always, the search box shows the UXDataComboBox or UXDataComboBox whenever searching is in progress. For more information about user experience features in ClientUI controls, see User Experiences Overview.

 

public DataTemplate BusyTemplate { get; set; }

Gets or sets the busy template.

Remarks

UXDataComboBox has several user experience aspects that you can customize, such as when to display the result box and when to show the busy text/template. Using the default settings, UXDataComboBox will not open the result box immediately when users type in a query text. Instead, it waits until the search result becomes available and then display it along with the result box. Users will then select an item from the available results. By setting the UXDataComboBox property to True, UXDataComboBox immediately opens the result box as you type into the text box. While waiting for the search result, the search box displays the UXDataComboBox or BusyTemplate which indicates that the searching is in progress. You can also determine the behavior of the UXDataComboBox or BusyTemplate by customizing the UXDataComboBox property. This property determines when the UXDataComboBox or BusyTemplate should be shown. If you set the UXDataComboBox to First, the search box shows the UXDataComboBox or BusyTemplate only once during the first search until the search is reset. In contrast, if you set the UXDataComboBox to Always, the search box shows the UXDataComboBox or BusyTemplate whenever searching is in progress. For more information about user experience features in ClientUI controls, see User Experiences Overview.

 

public string BusyText { get; set; }

Gets or sets the busy text.

Remarks

UXDataComboBox has several user experience aspects that you can customize, such as when to display the result box and when to show the busy text/template. Using the default settings, UXDataComboBox will not open the result box immediately when users type in a query text. Instead, it waits until the search result becomes available and then display it along with the result box. Users will then select an item from the available results. By setting the UXDataComboBox property to True, UXDataComboBox immediately opens the result box as you type into the text box. While waiting for the search result, the search box displays the BusyText or UXDataComboBox which indicates that the searching is in progress. You can also determine the behavior of the BusyText or UXDataComboBox by customizing the UXDataComboBox property. This property determines when the BusyText or UXDataComboBox should be shown. If you set the UXDataComboBox to First, the search box shows the BusyText or UXDataComboBox only once during the first search until the search is reset. In contrast, if you set the UXDataComboBox to Always, the search box shows the BusyText or UXDataComboBox whenever searching is in progress. For more information about user experience features in ClientUI controls, see User Experiences Overview.

 

public bool CanUserPage { get; set; }

Gets or sets a value indicating whether the search result can be paged.

Remarks

UXPageableComboBox provides a flexible way to display a collection of data in a single or multiple columns layout. Similar to UXDataComboBox, you need to input the query into UXPageableComboBox and handle the query using the QueryDescriptor component model. The control is designed with MVVM-ready architecture so that you can write the user interaction code entirely in the ViewModel including the implementation for paging feature. You can use the UXDataComboBox property to determine the number of item per page in your UXMultipleSelectionComboBox or disable the paging feature by setting the UXDataComboBox property to False.

 

public bool CanUserSort { get; set; }

Gets or sets a value indicating whether the search result can be sorted.

public Style ColumnHeaderStyle { get; set; }

Gets or sets the style that is used when rendering the column headers.

public StyleSelector ColumnHeaderStyleSelector { get; set; }

Gets or sets the style selector that is used when rendering the column headers.

public DataTemplateSelector ColumnHeaderTemplateSelector { get; set; }

Gets or sets the template selector that is used when rendering the column headers.

public Visibility ColumnHeaderVisibility { get; set; }

Gets or sets a value that indicates the visibility of column header.

public Visibility ColumnHeaderVisibilityCalculated { get; set; }

Gets or sets the column header visibility calculated text.

public ObservableCollection<UXDataComboBoxColumn> Columns { get; set; }

Gets or sets the columns that going to be displayed.

public Brush DescriptionForeground { get; set; }

Gets or sets the description foreground.

public double DescriptionMaxWidth { get; set; }

Gets or sets the description max width.

public string DescriptionMemberPath { get; set; }

Gets or sets the description member path.

public Style DescriptionStyle { get; set; }

Gets or sets the description style.

public string DescriptionText { get; set; }

Gets or sets the description text.

public Visibility DescriptionVisibility { get; set; }

Gets or sets the description visibility.

public CompositeFilterDescriptorCollection FilterDescriptors { get; set; }

Gets or sets the descriptor object that encapsulates the filtering related information.

public string FilterMemberPath { get; set; }

Gets or sets member path used in the filter descriptor.

public FilterOperator FilterOperator { get; set; }

Gets or sets filter operator used in the filter descriptor.

public Brush HeaderAndRowSeparatorBrush { get; set; }

Gets or sets the header and row separator brush.

public bool IsSearching { get; set; }

Gets or sets a value that indicates whether the UXDataComboBox is currently searching.

public string ItemsRetrievedText { get; set; }

Gets or sets the text when query return results.

public bool LoadDataWhenEmpty { get; set; }

Gets or sets a value indicating whether data combo box should load data when the drop down is opened and the text is empty.

Remarks

By default, UXPageableComboBox will display empty result when the query text is empty, but UXPageableComboBox also gives you an option to show all the records when the query text is empty. To activate this behavior, set the LoadDataWhenEmpty property to True.

 

public int MaxLength { get; set; }

Gets or sets the maximum character available for text input.

public DataTemplate NoResultTemplate { get; set; }

Gets or sets the no result template.

public string NoResultText { get; set; }

Gets or sets the text when query return no results.

public PageDescriptor PageDescriptor { get; set; }

Gets or sets the descriptor object that encapsulates the paging related information.

public int PageSize { get; set; }

Gets or sets the page size.

Remarks

You can use the PageSize property to determine the number of item per page in your UXMultipleSelectionComboBox or disable the paging feature by setting the UXDataComboBox property to False.

 

public double QueryLatency { get; set; }

Gets or sets the latency in seconds before query text is updated.

public string QueryText { get; set; }

Gets or sets the current query text.

public UXDataComboBoxResource ResourceOverride { get; set; }

Gets or sets the individual resource object to override the existing localized resource.

public ICommand SearchCommand { get; set; }

Gets or sets the SearchCommand to invoke when this button is clicked.

public NoExecuteBehavior SearchCommandCannotExecute { get; set; }

Gets or sets the UI behavior when the associated SearchCommand cannot be executed.

public object SearchCommandParameter { get; set; }

Gets or sets the parameter to pass to the SearchCommand property.

public UIElement SearchCommandTarget { get; set; }

Gets or sets the element on which to raise the specified SearchCommand.

public IEnumerable SearchResult { get; set; }

Gets or sets the search result collection to be displayed in the dropdown.

public bool ShowResultBoxOnEmptyData { get; set; }

Gets or sets a value indicating whether data combo box should open the drop down when no data retrieved.

public SortDescriptorCollection SortDescriptors { get; set; }

Gets or sets the descriptor object that encapsulates the sorting related information.

public string StatusBarText { get; }

Gets or sets the status text.

Remarks

In UXPageableComboBox, you can enable the status bar feature by set the UXDataComboBox property to Visible. The status bar will display any information about the records, such as total displayed records, total all records, searching progress, and button for browse all data.

 

public Visibility StatusBarVisibility { get; set; }

Gets or sets the status bar visibility.

Remarks

In UXPageableComboBox, you can enable the status bar feature by set the StatusBarVisibility property to Visible. The status bar will display any information about the records, such as total displayed records, total all records, searching progress, and button for browse all data.

 

public Brush VerticalLineBrush { get; set; }

Gets or sets the header and row separator brush.

public Visibility VerticalLineVisibility { get; set; }

Gets or sets the vertical line visibility.

Protected Properties

protected ProductInfo Product { get; }

Product Info.

Fields

public static readonly DependencyProperty AutoLoadMoreDataProperty

Identifies the AutoLoadMoreData dependency property.

public static readonly DependencyProperty AutoShowResultBoxProperty

Identifies the AutoShowResultBox dependency property.

public static readonly DependencyProperty AutoSynchronizeDropdownProperty

Identifies the AutoSynchronizeDropdown dependency property.

public static readonly DependencyProperty BusyModeProperty

Identifies the BusyMode dependency property.

public static readonly DependencyProperty BusyTextProperty

Identifies the BusyText dependency property.

public static readonly DependencyProperty CanUserPageProperty

Identifies the CanUserPage dependency property.

public static readonly DependencyProperty CanUserSortProperty

Identifies the CanUserSort dependency property.

public static readonly DependencyProperty ColumnHeaderStyleProperty

Identifies the ColumnHeaderStyle dependency property.

public static readonly DependencyProperty ColumnHeaderStyleSelectorProperty

Identifies the ColumnHeaderStyleSelector dependency property.

public static readonly DependencyProperty ColumnHeaderTemplateSelectorProperty

Identifies the ColumnHeaderTemplateSelector dependency property.

public static readonly DependencyProperty ColumnHeaderVisibilityCalculatedProperty

Identifies the ColumnHeaderVisibilityCalculated dependency property.

public static readonly DependencyProperty ColumnHeaderVisibilityProperty

Identifies the ColumnHeaderVisibility dependency property.

public static readonly DependencyProperty ColumnsProperty

Identifies the Columns dependency property.

public static readonly DependencyProperty DescriptionForegroundProperty

Identifies the DescriptionForeground dependency property.

public static readonly DependencyProperty DescriptionMaxWidthProperty

Identifies the DescriptionMaxWidth dependency property.

public static readonly DependencyProperty DescriptionMemberPathProperty

Identifies the DescriptionMemberPath dependency property.

public static readonly DependencyProperty DescriptionStyleProperty

Identifies the DescriptionStyle dependency property.

public static readonly DependencyProperty DescriptionTextProperty

Identifies the DescriptionText dependency property.

public static readonly DependencyProperty DescriptionVisibilityProperty

Identifies the DescriptionVisibility dependency property.

public static readonly DependencyProperty FilterDescriptorsProperty

Identifies the FilterDescriptors dependency property.

public static readonly DependencyProperty FilterMemberPathProperty

Identifies the FilterMemberPath dependency property.

public static readonly DependencyProperty FilterOperatorProperty

Identifies the FilterOperator dependency property.

public static readonly DependencyProperty HeaderAndRowSeparatorBrushProperty

Identifies the HeaderAndRowSeparatorBrush dependency property.

public static readonly DependencyProperty IsSearchingProperty

Identifies the IsSearching dependency property.

public static readonly DependencyProperty ItemsRetrievedTextProperty

Identifies the ItemsRetrieved dependency property.

public static readonly DependencyProperty LoadDataWhenEmptyProperty

Identifies the LoadDataWhenEmpty dependency property.

public static readonly DependencyProperty MaxLengthProperty

Identifies the MaxLength dependency property.

public static readonly DependencyProperty NoResultTextProperty

Identifies the NoResultText dependency property.

public static readonly DependencyProperty PageDescriptorProperty

Identifies the SortDescriptors dependency property.

public static readonly DependencyProperty PageSizeProperty

Identifies the PageSize dependency property.

public static readonly DependencyProperty QueryLatencyProperty

Identifies the QueryLatency dependency property.

public static readonly RoutedEvent QueryTextChangedEvent

Identifies the QueryTextChanged routed event.

public static readonly DependencyProperty QueryTextProperty

Identifies the QueryText dependency property.

public static readonly DependencyProperty ResourceOverrideProperty

Identifies the ResourceOverride dependency property.

public static readonly DependencyProperty SearchCommandCannotExecuteProperty

Identifies the SearchCommandCannotExecute dependency property.

public static readonly DependencyProperty SearchCommandParameterProperty

Identifies the SearchCommandParameter dependency property.

public static readonly DependencyProperty SearchCommandProperty

Identifies the Command dependency property.

public static readonly DependencyProperty SearchCommandTargetProperty

Identifies the SearchCommandTarget dependency property.

public static readonly DependencyProperty SearchResultProperty

Identifies the SearchResult dependency property.

public static readonly DependencyProperty ShowResultBoxOnEmptyDataProperty

Identifies the ShowResultBoxOnEmptyData dependency property.

public static readonly DependencyProperty SortDescriptorsProperty

Identifies the SortDescriptors dependency property.

public static readonly DependencyProperty StatusBarTextProperty

Identifies the StatusText dependency property.

public static readonly DependencyProperty StatusBarVisibilityProperty

Identifies the StatusBarVisibility dependency property.

public static readonly DependencyProperty VerticalLineBrushProperty

Identifies the VerticalLineBrush dependency property.

public static readonly DependencyProperty VerticalLineVisibilityProperty

Identifies the VerticalLineVisibility dependency property.

Public Methods

public void AttachEventHandlers()

Attach built-in event handlers to control templates. Call this method if necessary.

public void DetachedEventHandlers()

Detach built-in event handlers from control templates. Call this method if necessary.

public void Dispose()

Called when this object is disposed.

public void InitializeTemplates()

Initializes control templates.

public void OnApplyTemplate()

Builds the visual tree for the ISItemsControl when a new template is applied.

public void ResetAllSortState(UXDataComboBoxColumn defaultSortColumn)

Reset all column sort state, except the column that specified

Parameters

defaultSortColumnThe column that not included to be reset

 

public void ResetSortDescriptors()

Reset all sort descriptors

public void SelectValue(int newIndex)

 

Parameters

newIndex 

 

Protected Methods

protected DependencyObject GetContainerForItemOverride()

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

Return Types

The element that is used to display the given item.

 

protected bool IsItemItsOwnContainerOverride(object item)

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

Parameters

itemThe item to check.

Return Types

true if the item is (or is eligible to be) its own container; otherwise, false.

 

protected void Menu_Closed(object sender, ISRoutedEventArgs e)

On drop down menu closed.

Parameters

sender 
e 

 

protected void Menu_Opened(object sender, ISRoutedEventArgs e)

On drop down menu opened.

Parameters

sender 
e 

 

protected void OnAfterSelectedItemChanged(object newItem)

 

Parameters

newItem 

 

protected void OnColumnsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)

Called when the value of the Columns collection is changed.

Parameters

sender 
eNotifyCollectionChangedEventArgs that contains the event data

 

protected void OnGotFocus(RoutedEventArgs e)

 

Parameters

e 

 

protected void OnIsDropDownOpenChanged(DependencyPropertyChangedEventArgs e)

Called when the value of IsDropDownOpen property changes.

Parameters

eThe event data for the property change.

 

protected void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Called when the value of the ItemsControl.Items property changes.

Parameters

eNotifyCollectionChangedEventArgs that contains the event data.

 

protected void OnItemsSourceChanged(IEnumerable oldValue, IEnumerable newValue)

Called when the ItemsSource changes.

Parameters

oldValue 
newValue 

 

protected void OnKeyDown(KeyEventArgs e)

 

Parameters

e 

 

protected void OnLostFocus(RoutedEventArgs e)

 

Parameters

e 

 

protected void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Called before the MouseLeftButtonDown event occurs.

Parameters

eThe data for the event.

 

protected void OnSelectedItemChanged(object oldItem, object newItem)

Called when the value of the SelectedItem property changes.

Parameters

oldItemThe old value of the SelectedItem property.
newItemThe new value of the SelectedItem property.

 

protected void OnTextChanged(string oldText, string newText)

Called when the value of Text property changes.

Parameters

oldTextoldText
newTextnewText

 

Events

public event EventHandler<EventArgs> DataLoaded

 

public event EventHandler<EventArgs> DataLoading

 

public event QueryTextChangedEventHandler QueryTextChanged

Occurs when the selection of a ISelection changes.

  • No labels