PopupButton Class

[TemplatePart(Name = "PART_IndicatorArea", Type = typeof(UIElement))]
[TemplatePart(Name = "PART_Popup", Type = typeof(Popup))]
public class PopupButton : Button, DUCE.IResource, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IHaveResources, IQueryAmbient, IAddChild, ICommandSource, IPopupAnchor

public PopupButton()

public static RoutedCommand ClosePopupCommand { get; }

Property Value

RoutedCommand:

The ICommand that can close the popup.

public CornerRadius CornerRadius { get; set; }

Property Value

CornerRadius:

The CornerRadius for the control's border.

public PopupButtonDisplayMode DisplayMode { get; set; }

Property Value

PopupButtonDisplayMode:

A PopupButtonDisplayMode that describes how the content and popup indicator are rendered. The default value is Merged.

public bool HasDropShadow { get; set; }

Property Value

Boolean:

true if the popup will display a drop-shadow effect; otherwise, false. The default value is true.

Remarks

Setting this property to true has no effect if the SystemParameters.DropShadow property is false.

public bool IsAutoFocusOnOpenEnabled { get; set; }

Property Value

Boolean:

true if the popup content will be automatically focused when the popup is opened; otherwise, false. The default value is true.

public bool IsPopupOpen { get; set; }

Property Value

Boolean:

true if the popup is currently displayed; otherwise, false.

public bool IsTransparencyModeEnabled { get; set; }

Property Value

Boolean:

true if transparency mode is enabled; otherwise, false. The default value is false.

protected override IEnumerator LogicalChildren { get; }

Property Value

IEnumerator:

An enumerator for logical child elements of this element.

protected Popup Popup { get; set; }

Property Value

Popup:

The popup defined in the template.

public bool PopupAllowsTransparency { get; set; }

Property Value

Boolean:

true if transparency is allowed; otherwise, false. The default value is true.

Remarks

When this property is set to false, interop content will be able to render on the popup.

public PopupAnimation PopupAnimation { get; set; }

Property Value

PopupAnimation:

The PopupAnimation for the opening and closing of the associated popup.

public Brush PopupBackground { get; set; }

Property Value

Brush:

The Brush for the popup's background.

Remarks

This property is only used when PopupContent is specified.

public Brush PopupBorderBrush { get; set; }

Property Value

Brush:

The Brush for the popup's border.

Remarks

This property is only used when PopupContent is specified.

public Thickness PopupBorderThickness { get; set; }

Property Value

Thickness:

The Thickness for the popup's border.

Remarks

This property is only used when PopupContent is specified.

public object PopupContent { get; set; }

Property Value

Object:

The content that is displayed on the button's Popup.

Remarks

This can be any object, including panels of multiple controls. The PopupContentTemplate and/or PopupContentTemplateSelector properties can be used to customize the display of data objects (non-UI elements).

The PopupMenu property takes precedence over this property. Therefore, if PopupMenu is set, this property is ignored.

public DataTemplate PopupContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the PopupContent.

Remarks

This property is only useful if your popup content is a data object and not a UI element.

The PopupMenu property takes precedence over this property. Therefore, if PopupMenu is set, this property is ignored.

public DataTemplateSelector PopupContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector to use for the PopupContent.

Remarks

This property is only useful if your popup content is a data object and not a UI element.

The PopupMenu property takes precedence over this property. Therefore, if PopupMenu is set, this property is ignored.

public CornerRadius PopupCornerRadius { get; set; }

Property Value

CornerRadius:

The CornerRadius for the popup's border.

Remarks

This property is only used when PopupContent is specified.

public double PopupHorizontalOffset { get; set; }

Property Value

Double:

The horizontal distance between the target origin and the popup alignment point. The default value is 0.

public UIElement PopupIndicator { get; set; }

Property Value

UIElement:

The object used in the indicator portion.

public DataTemplate PopupIndicatorTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate used to present the indicator portion.

[Localizability(LocalizationCategory.ToolTip)]
public object PopupIndicatorToolTip { get; set; }

Property Value

Object:

The tool-tip object that is displayed for the popup indicator element.

public ContextMenu PopupMenu { get; set; }

Property Value

ContextMenu:

The ContextMenu that is opened by the PopupButton.

Remarks

This property takes precedence over the PopupContent-related properties. Therefore, if this property is set, the PopupContent-related properties are ignored.

public object PopupMenuDataContext { get; set; }

Property Value

Object:

The object to use as the PopupMenu data context. The default style binds this property to the PopupButton.DataContext.

Remarks

The DataContext property of the PopupMenu is bound to this property, if and only if the DataContext property was not already set on the ContextMenu.

public Thickness PopupPadding { get; set; }

Property Value

Thickness:

The Thickness of the popup's padding.

Remarks

This property is only used when PopupContent is specified.

public PlacementMode PopupPlacement { get; set; }

Property Value

PlacementMode:

A PlacementMode indicating where the popup appears relative to the button. The default value is Bottom.

public double PopupVerticalOffset { get; set; }

Property Value

Double:

The vertical distance between the target origin and the popup alignment point. The default value is 0.

public bool StaysOpen { get; set; }

Property Value

Boolean:

true if the Popup closes when the control is no longer in focus; otherwise, false. The default is false.

Remarks

This property has no effect when using PopupMenu.

protected bool FocusWithin()

Returns

Boolean:

true if a focusable descendant was found and focused; otherwise, false.

Remarks

This concept is necessary since various places within native ButtonBase code such as on mouse capture loss will blur focus if the button itself has focus.

public override void OnApplyTemplate()

protected override void OnClick()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

An AutomationPeer instance.

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)

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

protected override void OnKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	The KeyEventArgs instance containing the event data.

protected override void OnKeyUp(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	The KeyEventArgs instance containing the event data.

protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Parameter	Type	Description
e	MouseButtonEventArgs	The MouseButtonEventArgs instance containing the event data.

protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)

Parameter	Type	Description
e	MouseButtonEventArgs	The MouseButtonEventArgs instance containing the event data.

protected override void OnMouseWheel(MouseWheelEventArgs e)

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

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 OnPopupMenuChanged(ContextMenu oldValue, ContextMenu newValue)

Parameter	Type	Description
oldValue	ContextMenu	The old value.
newValue	ContextMenu	The new value.

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.

public event RoutedEventHandler PopupClosed

Event Type

RoutedEventHandler

public event RoutedEventHandler PopupOpened

Event Type

RoutedEventHandler

public event EventHandler<CancelRoutedEventArgs> PopupOpening

Event Type

EventHandler<CancelRoutedEventArgs>

bool IPopupAnchor.IsKeyboardFocusWithinPopup { get; }

Returns

Boolean:

true if keyboard focus is within the child popup; otherwise, false.

UIElement IPopupAnchor.PopupChild { get; }

Returns

UIElement:

The child element within the popup.

bool IPopupAnchor.PopupStaysOpen { get; }

Returns

Boolean:

true if the popup stays open, even when the popup loses focus, until explicitly closed.

bool IPopupAnchor.SupportsAltDownToOpen { get; }

Returns

Boolean:

true if the element supports pressing Alt+Down to open the popup; otherwise, false.

bool IPopupAnchor.WasPopupOpenedWithKeyboard { get; set; }

Returns

Boolean:

true if the child popup was opened via the keyboard; otherwise, false.

public static readonly DependencyProperty CornerRadiusProperty

public static readonly DependencyProperty DisplayModeProperty

public static readonly DependencyProperty HasDropShadowProperty

public static readonly DependencyProperty IsAutoFocusOnOpenEnabledProperty

public static readonly DependencyProperty IsPopupOpenProperty

public static readonly DependencyProperty IsTransparencyModeEnabledProperty

public static readonly DependencyProperty PopupAllowsTransparencyProperty

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 PopupContentProperty

public static readonly DependencyProperty PopupContentTemplateProperty

public static readonly DependencyProperty PopupContentTemplateSelectorProperty

public static readonly DependencyProperty PopupCornerRadiusProperty

public static readonly DependencyProperty PopupHorizontalOffsetProperty

public static readonly DependencyProperty PopupIndicatorProperty

public static readonly DependencyProperty PopupIndicatorTemplateProperty

public static readonly DependencyProperty PopupIndicatorToolTipProperty

public static readonly DependencyProperty PopupMenuDataContextProperty

public static readonly DependencyProperty PopupMenuProperty

public static readonly RoutedEvent PopupOpenedEvent

public static readonly RoutedEvent PopupOpeningEvent

public static readonly DependencyProperty PopupPaddingProperty

public static readonly DependencyProperty PopupPlacementProperty

public static readonly DependencyProperty PopupVerticalOffsetProperty

public static readonly DependencyProperty StaysOpenProperty