BarComboBox Class

[TemplatePart(Name = "PART_DropDownButton", Type = typeof(BarComboBoxDropDownButton))]
[TemplatePart(Name = "PART_TextBox", Type = typeof(TextBox))]
public class BarComboBox : BarMenuGalleryHostBase, ISupportsStarSizing

public BarComboBox()

protected override bool CanStopPreviewingOnMouseLeave { get; }

Property Value

bool:

true if the gallery can stop previewing when the mouse leaves the control; otherwise, false.

public CornerRadius CornerRadius { get; set; }

Property Value

CornerRadius

public bool HasDropShadow { get; set; }

Property Value

bool:

true if the popup has a drop shadow; otherwise, false. The default value is true.

public bool HasLabel { get; }

Property Value

bool:

true if the control has a Label available; otherwise, false. The default value is false.

public ImageSource? InlineImageSource { get; }

Property Value

ImageSource

[Localizability(LocalizationCategory.NeverLocalize)]
public string? InlineImageSourcePath { get; set; }

Property Value

string

public bool IsEditable { get; set; }

Property Value

bool:

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

public bool IsPopupOpen { get; set; }

Property Value

bool:

true if the popup is currently open; 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 star-sizing is allowed; 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 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

[Localizability(LocalizationCategory.Label)]
public string? KeyTipText { get; set; }

Property Value

string

public double MaxPopupHeight { get; set; }

Property Value

double:

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

[Localizability(LocalizationCategory.Text)]
public string? PlaceholderText { get; set; }

Property Value

string

public PopupAnimation PopupAnimation { get; set; }

Property Value

PopupAnimation

public Brush? PopupBackground { get; set; }

Property Value

Brush

public Brush? PopupBorderBrush { get; set; }

Property Value

Brush

public Thickness PopupBorderThickness { get; set; }

Property Value

Thickness

public CornerRadius PopupCornerRadius { get; set; }

Property Value

CornerRadius

public double PopupHorizontalOffset { get; set; }

Property Value

double

public DataTemplate? PopupIndicatorTemplate { get; set; }

Property Value

DataTemplate

public Thickness PopupPadding { get; set; }

Property Value

Thickness

public double PopupVerticalOffset { get; set; }

Property Value

double

public double RequestedWidth { get; set; }

Property Value

double:

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

public object? ScreenTipFooter { get; set; }

Property Value

object

public object? ScreenTipHeader { get; set; }

Property Value

object

[Localizability(LocalizationCategory.Text)]
public string? Text { get; set; }

Property Value

string

[Localizability(LocalizationCategory.NeverLocalize)]
public string? TextPath { get; set; }

Property Value

string

public ItemCollapseBehavior ToolBarItemCollapseBehavior { get; set; }

Property Value

ItemCollapseBehavior:

The ItemCollapseBehavior for the control when in a ribbon using Simplified layout mode. The default value is Default.

public ItemVariantBehavior ToolBarItemVariantBehavior { get; set; }

Property Value

ItemVariantBehavior:

The ItemVariantBehavior for the control when in a toolbar, which also applies when in a ribbon using Simplified layout mode. The default value is AlwaysSmall.

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 VariantSize VariantSize { get; set; }

Property Value

VariantSize

Remarks

This property should only be manually set when the control is standalone, and not hosted by a bar control.

protected override Size MeasureOverride(Size constraint)

Parameter	Type	Description
constraint	Size	The maximum size that the method can return.

Returns

Size:

The size of the control, up to the maximum specified by constraint.

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The type-specific AutomationPeer implementation.

protected override void OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameter	Type	Description
e	KeyboardFocusChangedEventArgs	The KeyboardFocusChangedEventArgs that contains the event data.

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)

Parameter	Type	Description
e	DependencyPropertyChangedEventArgs	The event data.

protected override void OnKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	Information about the event.

protected virtual void OnKeyTipInvoked(KeyTipInvokedEventArgs e)

Parameter	Type	Description
e	KeyTipInvokedEventArgs	The KeyTipInvokedEventArgs containing data related to this event.

protected virtual void OnKeyTipOpening(KeyTipOpeningEventArgs e)

Parameter	Type	Description
e	KeyTipOpeningEventArgs	The KeyTipOpeningEventArgs containing data related to this event.

protected override void OnLostKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameter	Type	Description
e	KeyboardFocusChangedEventArgs	The KeyboardFocusChangedEventArgs that contains event data.

protected virtual void OnPopupClosed(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	The event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnPopupOpened(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	The event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnPopupOpening(CancelRoutedEventArgs e)

Parameter	Type	Description
e	CancelRoutedEventArgs	The event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override void OnPreviewKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	The KeyEventArgs that contains the event data.

protected virtual void OnSelectedItemPropertyChanged(object? sender, PropertyChangedEventArgs e)

Parameter	Type	Description
sender	object	The sender of the event.
e	PropertyChangedEventArgs	The event data.

protected override void OnSelectionChanged(SelectionChangedEventArgs e)

Parameter	Type	Description
e	SelectionChangedEventArgs	The event data.

protected virtual void OnTextCommitted(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	The event data.

protected override void OnTextInput(TextCompositionEventArgs e)

Parameter	Type	Description
e	TextCompositionEventArgs	Information about the event.

public event RoutedEventHandler PopupClosed

Event Type

RoutedEventHandler

public event RoutedEventHandler PopupOpened

Event Type

RoutedEventHandler

public event EventHandler<CancelRoutedEventArgs> PopupOpening

Event Type

EventHandler<CancelRoutedEventArgs>

public event RoutedEventHandler TextCommitted

Event Type

RoutedEventHandler

public static readonly DependencyProperty CornerRadiusProperty

public static readonly DependencyProperty HasDropShadowProperty

public static readonly DependencyProperty HasLabelProperty

public static readonly DependencyProperty InlineImageSourcePathProperty

public static readonly DependencyProperty InlineImageSourceProperty

public static readonly DependencyProperty IsEditableProperty

public static readonly DependencyProperty IsPopupOpenProperty

public static readonly DependencyProperty IsPreviewEnabledWhenPopupClosedProperty

public static readonly DependencyProperty IsReadOnlyProperty

public static readonly DependencyProperty IsStarSizingAllowedProperty

public static readonly DependencyProperty IsTextCompletionEnabledProperty

public static readonly DependencyProperty IsUnmatchedTextAllowedProperty

public static readonly DependencyProperty KeyTipTextProperty

public static readonly DependencyProperty MaxPopupHeightProperty

public static readonly DependencyProperty PlaceholderTextProperty

public static readonly DependencyProperty PopupAnimationProperty

public static readonly DependencyProperty PopupBackgroundProperty

public static readonly DependencyProperty PopupBorderBrushProperty

public static readonly DependencyProperty PopupBorderThicknessProperty

public static readonly RoutedEvent PopupClosedEvent

public static readonly DependencyProperty PopupCornerRadiusProperty

public static readonly DependencyProperty PopupHorizontalOffsetProperty

public static readonly DependencyProperty PopupIndicatorTemplateProperty

public static readonly RoutedEvent PopupOpenedEvent

public static readonly RoutedEvent PopupOpeningEvent

public static readonly DependencyProperty PopupPaddingProperty

public static readonly DependencyProperty PopupVerticalOffsetProperty

public static readonly DependencyProperty RequestedWidthProperty

public static readonly DependencyProperty ScreenTipFooterProperty

public static readonly DependencyProperty ScreenTipHeaderProperty

public static readonly RoutedEvent TextCommittedEvent

public static readonly DependencyProperty TextPathProperty

public static readonly DependencyProperty TextProperty

public static readonly DependencyProperty ToolBarItemCollapseBehaviorProperty

public static readonly DependencyProperty ToolBarItemVariantBehaviorProperty

public static readonly DependencyProperty UnmatchedTextCommandProperty

public static readonly DependencyProperty VariantSizeProperty