RibbonQuickAccessToolBar Class
Represents a quick-access toolbar control, used within a ActiproSoftware.Windows.Controls.Bars.RibbonQuickAccessToolBar.Ribbon.
[TemplatePart(Name = "PART_InlineCustomizeButton", Type = typeof(RibbonQuickAccessToolBarCustomizeButton))]
[TemplatePart(Name = "PART_InlineOverflowButton", Type = typeof(RibbonQuickAccessToolBarOverflowPanel))]
[TemplatePart(Name = "PART_OverflowCustomizeButton", Type = typeof(RibbonQuickAccessToolBarCustomizeButton))]
[TemplatePart(Name = "PART_OverflowPanel", Type = typeof(RibbonQuickAccessToolBarOverflowButton))]
public class RibbonQuickAccessToolBar : ItemsControl, DUCE.IResource, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IHaveResources, IQueryAmbient, IAddChild, IGeneratorHost, IContainItemStorage, IOverflowingItemsControl, IOrientedElement
- Inheritance:
- System.Object System.Windows.Threading.DispatcherObject System.Windows.DependencyObject System.Windows.Media.Visual System.Windows.UIElement System.Windows.FrameworkElement System.Windows.Controls.Control System.Windows.Controls.ItemsControl Object
- Implements:
- IOverflowingItemsControl IOrientedElement
Constructors
RibbonQuickAccessToolBar()
Initializes a new instance of the RibbonQuickAccessToolBar class.
public RibbonQuickAccessToolBar()
Properties
AllowLabels
Gets or sets whether to allow labels on the items in the quick-access toolbar.
public bool AllowLabels { get; set; }
Property Value
- System.Boolean:
trueif labels should be allowed on the items in the quick-access toolbar; otherwise,false.
CommonItems
Gets or sets the collection of common items that are available to be quickly added or removed from the Customize button.
public IList CommonItems { get; set; }
Property Value
- System.Collections.IList:
The collection of common items that are available to be quickly added or removed from the
Customizebutton.
CustomizeButtonKeyTipText
Gets or sets the Customize button's key tip text.
[Localizability(LocalizationCategory.Label)]
public string CustomizeButtonKeyTipText { get; set; }
Property Value
- System.String:
The
Customizebutton's key tip text.
CustomizeButtonToolTip
Gets or sets the Customize button's tooltip.
public object CustomizeButtonToolTip { get; set; }
Property Value
- System.Object:
The
Customizebutton's tooltip.
IsCustomizeButtonVisible
Gets or sets whether the Customize button is visible.
public bool IsCustomizeButtonVisible { get; set; }
Property Value
- System.Boolean:
trueif theCustomizebutton is visible; otherwise,false.
IsInWindowTitleBar
Gets whether the QAT is in the window's title bar.
public bool IsInWindowTitleBar { get; }
Property Value
- System.Boolean:
trueif the QAT is in the window's title bar; otherwise,false.
IsOverflowed
Gets whether the control currently has overflowed items.
public bool IsOverflowed { get; }
Property Value
- System.Boolean:
trueif the control currently has overflowed items; otherwise,false.
Location
Gets or sets a RibbonQuickAccessToolBarLocation that indicates the current location of the quick-access toolbar.
public RibbonQuickAccessToolBarLocation Location { get; set; }
Property Value
- RibbonQuickAccessToolBarLocation:
A RibbonQuickAccessToolBarLocation that indicates the current location of the quick-access toolbar. The default value is Below.
OverflowButtonKeyTipText
Gets or sets the Overflow button's key tip text.
[Localizability(LocalizationCategory.Label)]
public string OverflowButtonKeyTipText { get; set; }
Property Value
- System.String:
The
Overflowbutton's key tip text.
OverflowButtonToolTip
Gets or sets the Overflow button's tooltip.
public object OverflowButtonToolTip { get; set; }
Property Value
- System.Object:
The
Overflowbutton's tooltip.
Methods
ClearContainerForItemOverride(DependencyObject, Object)
When overridden in a derived class, undoes the effects of the System.Windows.Controls.ItemsControl.PrepareContainerForItemOverride(System.Windows.DependencyObject, System.Object) method.
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
| Parameter | Type | Description |
|---|---|---|
| element | System.Windows.DependencyObject | The container element. |
| item | System.Object | The item. |
GetContainerForItemOverride()
Creates or identifies the element that is used to display the given item.
protected override DependencyObject GetContainerForItemOverride()
Returns
- System.Windows.DependencyObject:
The element that is used to display the given item.
IsItemItsOwnContainerOverride(Object)
Determines if the specified item is (or is eligible to be) its own container.
protected override bool IsItemItsOwnContainerOverride(object item)
| Parameter | Type | Description |
|---|---|---|
| item | System.Object | The item to check. |
Returns
- System.Boolean:
true if the item is (or is eligible to be) its own container; otherwise, false.
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate().
public override void OnApplyTemplate()
OnCreateAutomationPeer()
Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.
protected override AutomationPeer OnCreateAutomationPeer()
Returns
- System.Windows.Automation.Peers.AutomationPeer:
The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.
OnKeyDown(KeyEventArgs)
Invoked when the KeyDown event is received.
protected override void OnKeyDown(KeyEventArgs e)
| Parameter | Type | Description |
|---|---|---|
| e | System.Windows.Input.KeyEventArgs | Information about the event. |
PrepareContainerForItemOverride(DependencyObject, Object)
Prepares the specified element to display the specified item.
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
| Parameter | Type | Description |
|---|---|---|
| element | System.Windows.DependencyObject | Element used to display the specified item. |
| item | System.Object | Specified item. |
Explicit Interface Implementations
IOverflowingItemsControl.get_Items()
ItemCollection IOverflowingItemsControl.get_Items()
Returns
- System.Windows.Controls.ItemCollection
IOverflowingItemsControl.IsOverflowed
Gets or sets whether the control currently has overflowed items.
bool IOverflowingItemsControl.IsOverflowed { get; set; }
Returns
- System.Boolean:
trueif the control currently has overflowed items; otherwise,false.
IOverflowingItemsControl.ItemsHostPanel
Gets or sets the OverflowingItemsControlPanel used to host items within the main control.
OverflowingItemsControlPanel IOverflowingItemsControl.ItemsHostPanel { get; set; }
Returns
- OverflowingItemsControlPanel:
The OverflowingItemsControlPanel used to host items within the main control.
IOverflowingItemsControl.ItemSpacing
Gets the amount of spacing between items.
double IOverflowingItemsControl.ItemSpacing { get; }
Returns
- System.Double:
The amount of spacing between items.
IOverflowingItemsControl.OverflowPanel
Gets the OverflowingItemsControlOverflowPanel used to host overflowing items within a popup.
OverflowingItemsControlOverflowPanel IOverflowingItemsControl.OverflowPanel { get; }
Returns
- OverflowingItemsControlOverflowPanel:
The OverflowingItemsControlOverflowPanel used to host overflowing items within a popup.
IOrientedElement.Orientation
Gets the orientation of the element.
Orientation IOrientedElement.Orientation { get; }
Returns
- System.Windows.Controls.Orientation:
The orientation of the element.
Fields
AllowLabelsProperty
Identifies the AllowLabels dependency property. This field is read-only.
public static readonly DependencyProperty AllowLabelsProperty
CommonItemsProperty
Identifies the CommonItems dependency property. This field is read-only.
public static readonly DependencyProperty CommonItemsProperty
CustomizeButtonKeyTipTextProperty
Identifies the CustomizeButtonKeyTipText dependency property. This field is read-only.
public static readonly DependencyProperty CustomizeButtonKeyTipTextProperty
CustomizeButtonToolTipProperty
Identifies the CustomizeButtonToolTip dependency property. This field is read-only.
public static readonly DependencyProperty CustomizeButtonToolTipProperty
IsCustomizeButtonVisibleProperty
Identifies the IsCustomizeButtonVisible dependency property. This field is read-only.
public static readonly DependencyProperty IsCustomizeButtonVisibleProperty
IsInWindowTitleBarProperty
Identifies the IsInWindowTitleBar dependency property. This field is read-only.
public static readonly DependencyProperty IsInWindowTitleBarProperty
IsOverflowedProperty
Identifies the IsOverflowed dependency property. This field is read-only.
public static readonly DependencyProperty IsOverflowedProperty
LocationProperty
Identifies the Location dependency property. This field is read-only.
public static readonly DependencyProperty LocationProperty
OverflowButtonKeyTipTextProperty
Identifies the OverflowButtonKeyTipText dependency property. This field is read-only.
public static readonly DependencyProperty OverflowButtonKeyTipTextProperty
OverflowButtonToolTipProperty
Identifies the OverflowButtonToolTip dependency property. This field is read-only.
public static readonly DependencyProperty OverflowButtonToolTipProperty
Inherited Members
- System.Object.ToString()
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object, System.Object)
- System.Object.ReferenceEquals(System.Object, System.Object)
- System.Object.GetHashCode()
- System.Object.GetType()
- System.Object.MemberwiseClone()
Extension Methods
- FrameworkElementExtensions.AnimateDoubleProperty(String, Double, Double, Double, Nullable<Double>, Nullable<Double>)
- FrameworkElementExtensions.BindToProperty(DependencyProperty, Object, String, BindingMode, IValueConverter, Object)
- FrameworkElementExtensions.BindToProperty(DependencyProperty, Object, DependencyProperty, BindingMode, IValueConverter, Object)
- FrameworkElementExtensions.GetCurrentSize()