BarPopupButtonBase Class

[TemplatePart(Name = "PART_IndicatorArea", Type = typeof(UIElement))]
[TemplatePart(Name = "PART_Popup", Type = typeof(Popup))]
[TemplatePart(Name = "PART_PopupContentHost", Type = typeof(ResizablePopupContentHost))]
public abstract class BarPopupButtonBase : Menu, IPopupAnchor

protected BarPopupButtonBase()

public bool CanEffectivelyExecute { get; protected set; }

Property Value

bool:

true if the control can effectively execute the Command; otherwise, false.

public bool CanEffectivelyOpenPopup { get; protected set; }

Property Value

bool:

true if the control can effectively open its popup; otherwise, false.

protected virtual bool CanFocusSelectedGalleryItemOnPopupOpen { get; }

Property Value

bool:

true if the button can focus a selected gallery item when the popup is opened; otherwise, false.

public ICommand Command { get; set; }

Property Value

ICommand:

The ICommand related to this button.

public object CommandParameter { get; set; }

Property Value

object:

The parameter for the Command.

public IInputElement CommandTarget { get; set; }

Property Value

IInputElement:

The IInputElement target for the Command.

public CornerRadius CornerRadius { get; set; }

Property Value

CornerRadius:

The corner radius of the control's border.

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.

protected override bool IsEnabledCore { get; }

Property Value

bool:

true if the element is enabled; otherwise, 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 IsPressed { get; protected set; }

Property Value

bool:

true if the control is currently pressed; otherwise, false. The default value is false.

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

Property Value

string:

The key tip text used to access the control.

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

Property Value

string:

The text label to display.

public double ParentGalleryMinWidth { get; protected set; }

Property Value

double:

The parent gallery's minimum width.

public PopupAnimation PopupAnimation { get; set; }

Property Value

PopupAnimation:

The PopupAnimation to use in the popup.

public Brush PopupBackground { get; set; }

Property Value

Brush:

The Brush for the popup's background.

public Brush PopupBorderBrush { get; set; }

Property Value

Brush:

The Brush for the popup's border.

public Thickness PopupBorderThickness { get; set; }

Property Value

Thickness:

The Thickness of the popup's border.

public CornerRadius PopupCornerRadius { get; set; }

Property Value

CornerRadius:

The CornerRadius of the popup's border.

public double PopupHorizontalOffset { get; set; }

Property Value

double:

The horizontal offset of the popup.

public DataTemplate PopupIndicatorTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate for the popup indicator.

public ICommand PopupOpeningCommand { get; set; }

Property Value

ICommand:

The ICommand that executes before the button's popup is opened, allowing its items to be customized in MVVM scenarios.

public Thickness PopupPadding { get; set; }

Property Value

Thickness:

The Thickness of the popup's padding.

public double PopupVerticalOffset { get; set; }

Property Value

double:

The vertical offset of the popup.

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The container element.
item	object	The item.

protected virtual void ExecuteClickFromKeyboard()

protected override DependencyObject GetContainerForItemOverride()

Returns

DependencyObject:

The element used to display the specified item.

protected override void HandleMouseButton(MouseButtonEventArgs e)

Parameter	Type	Description
e	MouseButtonEventArgs	A MouseButtonEventArgs that contains the event data.

protected override bool IsItemItsOwnContainerOverride(object item)

Parameter	Type	Description
item	object	The item to check whether it is an item container.

Returns

bool:

true if the item is a MenuItem or a Separator; otherwise, false.

protected bool IsOverButtonArea(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	The MouseEventArgs to examine.

Returns

bool:

true if the pointer is over the control's button area; otherwise, false.

public override void OnApplyTemplate()

protected virtual void OnClick(RoutedEventArgs e)

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

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 OnIndicatorAreaMouseDown(MouseButtonEventArgs e)

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

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)

Parameter	Type	Description
e	DependencyPropertyChangedEventArgs	The event data for the IsKeyboardFocusWithinChanged event.

protected override void OnKeyDown(KeyEventArgs e)

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

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 virtual void OnPopupClosed(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	The RoutedEventArgs that contains 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 RoutedEventArgs that contains 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 CancelRoutedEventArgs that contains 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 OnPreviewKeyUp(KeyEventArgs e)

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

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The element used to display the specified item.
item	object	The item to display.

protected virtual bool SetFocusForIndicatorAreaMouseDown()

Returns

bool:

true if focus was set; otherwise, false.

protected virtual void UpdateEnabledProperties()

protected virtual void UpdatePopupPlacement()

public event RoutedEventHandler PopupClosed

Event Type

RoutedEventHandler

public event RoutedEventHandler PopupOpened

Event Type

RoutedEventHandler

public event EventHandler<CancelRoutedEventArgs> PopupOpening

Event Type

EventHandler<CancelRoutedEventArgs>

public static readonly DependencyProperty CanEffectivelyExecuteProperty

public static readonly DependencyProperty CanEffectivelyOpenPopupProperty

public static readonly DependencyProperty CommandParameterProperty

public static readonly DependencyProperty CommandProperty

public static readonly DependencyProperty CommandTargetProperty

public static readonly DependencyProperty CornerRadiusProperty

public static readonly DependencyProperty HasDropShadowProperty

public static readonly DependencyProperty HasLabelProperty

public static readonly DependencyProperty IsPopupOpenProperty

public static readonly DependencyProperty IsPressedProperty

public static readonly DependencyProperty KeyTipTextProperty

public static readonly DependencyProperty LabelProperty

public static readonly DependencyProperty ParentGalleryMinWidthProperty

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 DependencyProperty PopupOpeningCommandProperty

public static readonly RoutedEvent PopupOpeningEvent

public static readonly DependencyProperty PopupPaddingProperty

public static readonly DependencyProperty PopupVerticalOffsetProperty