BarComboBoxViewModel Class

public class BarComboBoxViewModel : BarGalleryViewModel, IHasKey, IHasVariantImages

public BarComboBoxViewModel()

public BarComboBoxViewModel(string key)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.

public BarComboBoxViewModel(string key, IEnumerable items)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public BarComboBoxViewModel(string key, string label)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the key if null.

public BarComboBoxViewModel(string key, string label, IEnumerable items)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the key if null.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public BarComboBoxViewModel(string key, string label, string keyTipText)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the key if null.
keyTipText	string	The key tip text, which is auto-generated from the label if null.

public BarComboBoxViewModel(string key, string label, string keyTipText, IEnumerable items)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the key if null.
keyTipText	string	The key tip text, which is auto-generated from the label if null.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public BarComboBoxViewModel(string key, string label, string keyTipText, ICommand command)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the command or key if null.
keyTipText	string	The key tip text, which is auto-generated from the command or label if null.
command	ICommand	The command to attach to the control.

public BarComboBoxViewModel(string key, string label, string keyTipText, ICommand command, IEnumerable items)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the command or key if null.
keyTipText	string	The key tip text, which is auto-generated from the command or label if null.
command	ICommand	The command to attach to the control.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public BarComboBoxViewModel(string key, string label, ICommand command)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the command or key if null.
command	ICommand	The command to attach to the control.

public BarComboBoxViewModel(string key, string label, ICommand command, IEnumerable items)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the command or key if null.
command	ICommand	The command to attach to the control.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public BarComboBoxViewModel(string key, ICommand command)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
command	ICommand	The command to attach to the control.

public BarComboBoxViewModel(string key, ICommand command, IEnumerable items)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
command	ICommand	The command to attach to the control.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public BarComboBoxViewModel(RoutedCommand routedCommand)

Parameter	Type	Description
routedCommand	RoutedCommand	The command to attach to the control.

public BarComboBoxViewModel(RoutedCommand routedCommand, IEnumerable items)

Parameter	Type	Description
routedCommand	RoutedCommand	The command to attach to the control.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public string Description { get; set; }

Property Value

string:

The text description to display in screen tips.

public bool IsEditable { get; set; }

Property Value

bool:

true if the combobox is editable; otherwise, false. The default value is false.

public bool IsPreviewEnabledWhenPopupClosed { get; set; }

Property Value

bool:

true if an editable combobox will preview a gallery item if the item is matched by typed text while the popup is closed; otherwise, false. The default value is false.

public bool IsReadOnly { get; set; }

Property Value

bool:

true if the combobox is read-only; otherwise, false. The default value is false.

public bool IsStarSizingAllowed { get; set; }

Property Value

bool:

true if the control can star-size; otherwise, false. The default value is false.

public bool IsTextCompletionEnabled { get; set; }

Property Value

bool:

true if the control will attempt to complete typed text with a matching item; otherwise, false. The default value is true.

public bool IsTextSearchCaseSensitive { get; set; }

Property Value

bool:

true if text searches are case-sensitive; otherwise false. The default value is false.

See Also

• IsTextSearchEnabled
• UnmatchedTextCommand

public bool IsTextSearchEnabled { get; set; }

Property Value

bool:

true if items are matched when text is entered; otherwise false. The default value is true.

See Also

• IsTextSearchCaseSensitive
• UnmatchedTextCommand

public bool IsUnmatchedTextAllowed { get; set; }

Property Value

bool:

true if committed Text that is unable to be matched to a gallery item will raise the UnmatchedTextCommand and possibly be allowed; otherwise, false. The default value is true.

See Also

• UnmatchedTextCommand

public double MaxPopupHeight { get; set; }

Property Value

double:

The maximum popup height. The default value is Double.PositiveInfinity.

public string PlaceholderText { get; set; }

Property Value

string:

The placeholder text to display when the control is empty.

public double RequestedWidth { get; set; }

Property Value

double:

The requested width of the control. The default value is 110.

public string Text { get; set; }

Property Value

string:

The text to display in the control.

public string TextPath { get; set; }

Property Value

string:

The path to a string gallery item property, corresponding to Text display and entry.

public ICommand UnmatchedTextCommand { get; set; }

Property Value

ICommand:

The ICommand to execute when Text is committed that is unable to be matched to a gallery item or when IsTextSearchEnabled is false.

Remarks

This command is only used when the IsUnmatchedTextAllowed property is true. The unmatched text string is passed as a command parameter.

When the command is null or CanExecute(object) returns true, the text will be committed; otherwise, it will not be committed.

See Also

• IsUnmatchedTextAllowed

public virtual void SelectItemByTextMatch<T>(Func<T, string> getItemTextFunc, string text) where T : IBarGalleryItemViewModel

Type Parameters:

T -

The type of IBarGalleryItemViewModel to examine.

Parameter	Type	Description
getItemTextFunc	Func<T, string>	A function that examines an item and returns its string value for comparison to text.
text	string	The text for which to search and that will be set to Text.

public virtual void SelectItemByValueMatch<T>(Func<T, bool> matchPredicate, Func<T, string> getMatchedItemTextFunc, string fallbackText) where T : IBarGalleryItemViewModel

Type Parameters:

T -

The type of IBarGalleryItemViewModel to examine.

Parameter	Type	Description
matchPredicate	Func<T, bool>	A predicate that determines when an item matches criteria.
getMatchedItemTextFunc	Func<T, string>	A function that examines a matched item and returns the string value to set to Text.
fallbackText	string	The fallback text to set to Text when there is no match.