BarPopupButton Class
Represents a popup button control, for use within a ribbon or toolbar.
public class BarPopupButton : BarPopupButtonBase, IPopupAnchor
- Inheritance:
- object Visual UIElement FrameworkElement Control ItemsControl MenuBase Menu BarPopupButtonBase object
- Implements:
- IPopupAnchor
Constructors
BarPopupButton()
Initializes a new instance of the BarPopupButton class.
public BarPopupButton()
Properties
CanCloneToRibbonQuickAccessToolBar
Gets or sets whether the control can be cloned to the ribbon quick-access toolbar.
public bool CanCloneToRibbonQuickAccessToolBar { get; set; }
Property Value
- bool:
true
if the control can be cloned to the ribbon quick-access toolbar; otherwise,false
. The default value istrue
.
ImageSourceResolved
Gets the resolved ImageSource for the image to use in the control's template.
public ImageSource ImageSourceResolved { get; }
Property Value
- ImageSource:
The resolved ImageSource for the image to use in the control's template.
Key
Gets or sets a string that uniquely identifies the control.
[Localizability(LocalizationCategory.NeverLocalize)]
public string Key { get; set; }
Property Value
- string:
A string that uniquely identifies the control.
LargeImageSource
Gets or sets the ImageSource for a large image, generally 32x32
size.
public ImageSource LargeImageSource { get; set; }
Property Value
- ImageSource:
The ImageSource for a large image.
MediumImageSource
Gets or sets the ImageSource for a medium image, generally 24x24
size.
public ImageSource MediumImageSource { get; set; }
Property Value
- ImageSource:
The ImageSource for a medium image.
PopupIndicatorMargin
Gets or sets the Thickness of the margin around the popup indicator.
public Thickness PopupIndicatorMargin { get; set; }
Property Value
ScreenTipFooter
Gets or sets the screen tip footer content.
ScreenTipHeader
Gets or sets the screen tip header content.
SmallImageSource
Gets or sets the ImageSource for a small image, generally 16x16
size.
public ImageSource SmallImageSource { get; set; }
Property Value
- ImageSource:
The ImageSource for a small image.
Title
Gets or sets the string title, which can override the Label when displayed in screen tips and customization UI.
[Localizability(LocalizationCategory.Title)]
public string Title { get; set; }
Property Value
- string:
The string title.
ToolBarItemCollapseBehavior
Gets or sets the ItemCollapseBehavior for the control when in a ribbon using Simplified layout mode.
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
.
ToolBarItemVariantBehavior
Gets or sets the ItemVariantBehavior for the control when in a toolbar, which also applies when in a ribbon using Simplified layout mode.
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
.
UserInterfaceDensity
Gets or sets a UserInterfaceDensity that indicates how compact or spacious the UI should appear.
public UserInterfaceDensity UserInterfaceDensity { get; set; }
Property Value
- UserInterfaceDensity:
A UserInterfaceDensity that indicates how compact or spacious the UI should appear. The default value is Compact.
VariantSize
Gets or sets the VariantSize currently assigned to the control. This property should only be manually set when the control is standalone, and not hosted by a bar control.
public VariantSize VariantSize { get; set; }
Property Value
- VariantSize:
The VariantSize currently assigned to the control.
Methods
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate().
public override void OnApplyTemplate()
OnCreateAutomationPeer()
Provides an appropriate MenuAutomationPeer implementation for this control, as part of the WPF automation infrastructure.
protected override AutomationPeer OnCreateAutomationPeer()
Returns
- AutomationPeer:
The type-specific AutomationPeer implementation.
OnToolTipOpening(ToolTipEventArgs)
Invoked whenever the ToolTipOpening routed event reaches this class in its route. Implement this method to add class handling for this event.
protected override void OnToolTipOpening(ToolTipEventArgs e)
Parameter | Type | Description |
---|---|---|
e | ToolTipEventArgs | Provides data about the event. |
ToString()
Returns the string representation of this object.
Fields
CanCloneToRibbonQuickAccessToolBarProperty
Identifies the CanCloneToRibbonQuickAccessToolBar dependency property. This field is read-only.
public static readonly DependencyProperty CanCloneToRibbonQuickAccessToolBarProperty
ImageSourceResolvedProperty
Identifies the ImageSourceResolved dependency property. This field is read-only.
public static readonly DependencyProperty ImageSourceResolvedProperty
KeyProperty
Identifies the Key dependency property. This field is read-only.
public static readonly DependencyProperty KeyProperty
LargeImageSourceProperty
Identifies the LargeImageSource dependency property. This field is read-only.
public static readonly DependencyProperty LargeImageSourceProperty
MediumImageSourceProperty
Identifies the MediumImageSource dependency property. This field is read-only.
public static readonly DependencyProperty MediumImageSourceProperty
PopupIndicatorMarginProperty
Identifies the PopupIndicatorMargin dependency property. This field is read-only.
public static readonly DependencyProperty PopupIndicatorMarginProperty
ScreenTipFooterProperty
Identifies the ScreenTipFooter dependency property. This field is read-only.
public static readonly DependencyProperty ScreenTipFooterProperty
ScreenTipHeaderProperty
Identifies the ScreenTipHeader dependency property. This field is read-only.
public static readonly DependencyProperty ScreenTipHeaderProperty
SmallImageSourceProperty
Identifies the SmallImageSource dependency property. This field is read-only.
public static readonly DependencyProperty SmallImageSourceProperty
TitleProperty
Identifies the Title dependency property. This field is read-only.
public static readonly DependencyProperty TitleProperty
ToolBarItemCollapseBehaviorProperty
Identifies the ToolBarItemCollapseBehavior dependency property. This field is read-only.
public static readonly DependencyProperty ToolBarItemCollapseBehaviorProperty
ToolBarItemVariantBehaviorProperty
Identifies the ToolBarItemVariantBehavior dependency property. This field is read-only.
public static readonly DependencyProperty ToolBarItemVariantBehaviorProperty
UserInterfaceDensityProperty
Identifies the UserInterfaceDensity dependency property. This field is read-only.
public static readonly DependencyProperty UserInterfaceDensityProperty
VariantSizeProperty
Identifies the VariantSize dependency property. This field is read-only.
public static readonly DependencyProperty VariantSizeProperty
Inherited Members
- BarPopupButtonBase.PopupClosedEvent
- BarPopupButtonBase.PopupOpenedEvent
- BarPopupButtonBase.PopupOpeningEvent
- BarPopupButtonBase.CanEffectivelyExecuteProperty
- BarPopupButtonBase.CanEffectivelyOpenPopupProperty
- BarPopupButtonBase.CommandProperty
- BarPopupButtonBase.CommandParameterProperty
- BarPopupButtonBase.CommandTargetProperty
- BarPopupButtonBase.CornerRadiusProperty
- BarPopupButtonBase.HasDropShadowProperty
- BarPopupButtonBase.HasLabelProperty
- BarPopupButtonBase.IsPopupOpenProperty
- BarPopupButtonBase.IsPressedProperty
- BarPopupButtonBase.KeyTipTextProperty
- BarPopupButtonBase.LabelProperty
- BarPopupButtonBase.ParentGalleryMinWidthProperty
- BarPopupButtonBase.PopupAnimationProperty
- BarPopupButtonBase.PopupBackgroundProperty
- BarPopupButtonBase.PopupBorderBrushProperty
- BarPopupButtonBase.PopupBorderThicknessProperty
- BarPopupButtonBase.PopupCornerRadiusProperty
- BarPopupButtonBase.PopupHorizontalOffsetProperty
- BarPopupButtonBase.PopupIndicatorTemplateProperty
- BarPopupButtonBase.PopupOpeningCommandProperty
- BarPopupButtonBase.PopupPaddingProperty
- BarPopupButtonBase.PopupVerticalOffsetProperty
- BarPopupButtonBase.ClearContainerForItemOverride(DependencyObject, object)
- BarPopupButtonBase.ExecuteClickFromKeyboard()
- BarPopupButtonBase.GetContainerForItemOverride()
- BarPopupButtonBase.HandleMouseButton(MouseButtonEventArgs)
- BarPopupButtonBase.IsItemItsOwnContainerOverride(object)
- BarPopupButtonBase.IsOverButtonArea(MouseEventArgs)
- BarPopupButtonBase.OnClick(RoutedEventArgs)
- BarPopupButtonBase.OnIndicatorAreaMouseDown(MouseButtonEventArgs)
- BarPopupButtonBase.OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs)
- BarPopupButtonBase.OnKeyDown(KeyEventArgs)
- BarPopupButtonBase.OnKeyTipInvoked(KeyTipInvokedEventArgs)
- BarPopupButtonBase.OnKeyTipOpening(KeyTipOpeningEventArgs)
- BarPopupButtonBase.OnPopupClosed(RoutedEventArgs)
- BarPopupButtonBase.OnPopupOpened(RoutedEventArgs)
- BarPopupButtonBase.OnPopupOpening(CancelRoutedEventArgs)
- BarPopupButtonBase.OnPreviewKeyUp(KeyEventArgs)
- BarPopupButtonBase.PrepareContainerForItemOverride(DependencyObject, object)
- BarPopupButtonBase.SetFocusForIndicatorAreaMouseDown()
- BarPopupButtonBase.UpdateEnabledProperties()
- BarPopupButtonBase.UpdatePopupPlacement()
- BarPopupButtonBase.CanEffectivelyExecute
- BarPopupButtonBase.CanEffectivelyOpenPopup
- BarPopupButtonBase.CanFocusSelectedGalleryItemOnPopupOpen
- BarPopupButtonBase.Command
- BarPopupButtonBase.CommandParameter
- BarPopupButtonBase.CommandTarget
- BarPopupButtonBase.CornerRadius
- BarPopupButtonBase.HasDropShadow
- BarPopupButtonBase.HasLabel
- BarPopupButtonBase.IsEnabledCore
- BarPopupButtonBase.IsPopupOpen
- BarPopupButtonBase.IsPressed
- BarPopupButtonBase.KeyTipText
- BarPopupButtonBase.Label
- BarPopupButtonBase.ParentGalleryMinWidth
- BarPopupButtonBase.PopupAnimation
- BarPopupButtonBase.PopupBackground
- BarPopupButtonBase.PopupBorderBrush
- BarPopupButtonBase.PopupBorderThickness
- BarPopupButtonBase.PopupCornerRadius
- BarPopupButtonBase.PopupHorizontalOffset
- BarPopupButtonBase.PopupIndicatorTemplate
- BarPopupButtonBase.PopupOpeningCommand
- BarPopupButtonBase.PopupPadding
- BarPopupButtonBase.PopupVerticalOffset
- BarPopupButtonBase.PopupClosed
- BarPopupButtonBase.PopupOpened
- BarPopupButtonBase.PopupOpening