Class Ribbon
Represents a Ribbon control.
Inheritance
Implements
Namespace: Syncfusion.Windows.Tools.Controls
Assembly: Syncfusion.Tools.Wpf.dll
Syntax
[SkinType(SkinVisualStyle = Skin.Office2007Blue, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF;component/Framework/Ribbon/Themes/Office2007BlueStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2007Black, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/Office2007BlackStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2007Silver, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/Office2007SilverStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2003, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/Office2003Style.xaml")]
[SkinType(SkinVisualStyle = Skin.Blend, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/BlendStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.ShinyRed, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/ShinyRedStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.ShinyBlue, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/ShinyBlueStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Default, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF;component/Framework/Ribbon/Themes/Generic.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Black, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/Office2010BlackStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Blue, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/Office2010BlueStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Silver, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/Office2010SilverStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.VS2010, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/VS2010Style.xaml")]
[SkinType(SkinVisualStyle = Skin.SyncOrange, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/SyncOrangeStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Metro, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/MetroStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Transparent, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/TransparentStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Windows8, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF;component/Framework/Ribbon/Themes/Windows8Style.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2013, Type = typeof(Ribbon), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/Office2013Style.xaml")]
public class Ribbon : Selector, IDisposable
Remarks
Ribbon class represents main Ribbon control that hosts RibbonTabs elements.
Examples
This example shows how to create a Ribbon in XAML.
<ribbon:Ribbon x:Name="MyRibbon">
<ribbon:RibbonTab Caption="Home"/>
<ribbon:RibbonTab Caption="Insert"/>
</ribbon:Ribbon x:Name="MyRibbon">
This example shows how to create a Ribbon in C#.
StackPanel stackPanel;
RibbonTab tab1;
RibbonTab tab2;
Ribbon ribbon = new Ribbon();
ribbon.Items.Add(tab1);
ribbon.Items.Add(tab2);
stackPanel.Children.Add( ribbon );
Constructors
Ribbon()
Initializes a new instance of the Ribbon class.
Declaration
public Ribbon()
Fields
ActiveColorSchemeProperty
Defines whether Color Scheme is applied to control. This is a dependency property.
Declaration
public static readonly DependencyProperty ActiveColorSchemeProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
AddItemToQATProperty
Defines Add item to QAT. This is a dependency property.
Declaration
public static readonly DependencyProperty AddItemToQATProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
AllowAdornerStateProperty
Identifies the AllowAdornerState dependency property.
Declaration
public static readonly DependencyProperty AllowAdornerStateProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the AllowAdornerState dependency property.
AllowCloneItemsProperty
Identifies the
Declaration
public static readonly DependencyProperty AllowCloneItemsProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the
AllowKeyTipProperty
Defines whether the KeyTip need to display or not. This is a dependency property.
Declaration
public static readonly DependencyProperty AllowKeyTipProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
ApplicationMenuHeaderProperty
Identifies the ApplicationMenuHeader dependency property.
Declaration
public static readonly DependencyProperty ApplicationMenuHeaderProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the ApplicationMenuHeader dependency property.
ApplicationMenuProperty
Identifies Application Menu of the ribbon. This is a dependency property.
Declaration
public static readonly DependencyProperty ApplicationMenuProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
AutoPersistProperty
Identifies the AutoPersist dependency property.
Declaration
public static readonly DependencyProperty AutoPersistProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
BackStageButtonProperty
Identifies the BackStageButton dependency property.
Declaration
public static readonly DependencyProperty BackStageButtonProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the BackStageButton dependency property.
BackStageColorProperty
Identifies the BackStageColor dependency property.
Declaration
public static readonly DependencyProperty BackStageColorProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the BackStageColor dependency property.
BackStageCornerImageVisibilityProperty
Identifies the BackStageCornerImageVisibility dependency property.
Declaration
public static readonly DependencyProperty BackStageCornerImageVisibilityProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the BackStageCornerImageVisibility dependency property.
BackStageHeaderProperty
Identifies the BackStageHeader dependency property.
Declaration
public static readonly DependencyProperty BackStageHeaderProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the BackStageHeader dependency property.
BackStageProperty
Identifies the BackStage dependency property.
Declaration
public static readonly DependencyProperty BackStageProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the BackStage dependency property.
BindableChildrenProperty
Using a DependencyProperty as the backing store for items to initialize the children of the System.Windows.Controls.Grid. This enables support to intialize the items to children of the System.Windows.Controls.Grid.
Declaration
public static readonly DependencyProperty BindableChildrenProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
ContextAdornerStyleProperty
Identifies the ContextAdornerStyle dependency property.
Declaration
public static readonly DependencyProperty ContextAdornerStyleProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the ContextAdornerStyle dependency property.
ContextGroupContainerStyleProperty
Identifies the ContextGroupContainerStyle dependency property.
Declaration
public static readonly DependencyProperty ContextGroupContainerStyleProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the ContextGroupContainerStyle dependency property.
ContextGroupSourceProperty
Identifies the ContextGroupSource dependency property.
Declaration
public static readonly DependencyProperty ContextGroupSourceProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the ContextGroupSource dependency property.
ContextTabGroupsProperty
Identifies collection of ribbon ContextTabGroups. This is a dependency property.
Declaration
public static readonly DependencyProperty ContextTabGroupsProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
CustomizeQATProperty
Defines QAT is customize. This is a dependency property.
Declaration
public static readonly DependencyProperty CustomizeQATProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
DynamicItemProperty
Identifies the DynamicItemProperty dependency property.
Declaration
public static readonly DependencyProperty DynamicItemProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the DynamicItemProperty dependency property.
DynamicItemTagProperty
Identifies the DynamicItemTagProperty dependency property.
Declaration
public static readonly DependencyProperty DynamicItemTagProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the DynamicItemTagProperty dependency property.
EnableMoreCommandsProperty
Defines whether QAT Customization Dialog Window Enabled or not. This is a dependency property.
Declaration
public static readonly DependencyProperty EnableMoreCommandsProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
EnableSimplifiedLayoutModeProperty
Identifies the EnableSimplifiedLayoutMode dependency property.
Declaration
public static readonly DependencyProperty EnableSimplifiedLayoutModeProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the EnableSimplifiedLayoutMode dependency property.
HasVisibleContextTabGroupProperty
Gets whether Ribbon has visible context tab groups. This is a dependency property.
Declaration
public static readonly DependencyProperty HasVisibleContextTabGroupProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
HasVisibleContextTabGroupPropertyKey
Identifies whether there is any visible ContextTabGroup. This is a dependency property.
Declaration
protected static readonly DependencyPropertyKey HasVisibleContextTabGroupPropertyKey
Field Value
| Type |
|---|
| System.Windows.DependencyPropertyKey |
IsAutoSizeFormEnabledProperty
Identifies the IsAutoSizeFormEnabledProperty dependency property.
Declaration
public static readonly DependencyProperty IsAutoSizeFormEnabledProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the IsAutoSizeFormEnabledProperty dependency property.
IsBackStageVisibleProperty
Identifies the IsBackStageVisible dependency property.
Declaration
public static readonly DependencyProperty IsBackStageVisibleProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the IsBackStageVisible dependency property.
IsQATBelowProperty
Defines whether QAT is below or above the ribbon. This is a dependency property.
Declaration
public static readonly DependencyProperty IsQATBelowProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
IsQATContextMenuEnabledProperty
Identifies the IsQATContextMenuEnabled dependency property.
Declaration
public static readonly DependencyProperty IsQATContextMenuEnabledProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the IsQATContextMenuEnabled dependency property.
IsQATCustomizationEnabledProperty
Identifies the IsQATCustomizationEnabled dependency property.
Declaration
public static readonly DependencyProperty IsQATCustomizationEnabledProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the IsQATCustomizationEnabled dependency property.
IsQATItemProperty
Defines whether QATItem is item of the ribbon. This is a dependency property.
Declaration
public static readonly DependencyProperty IsQATItemProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
IsQATMoveBelowEnabledProperty
Identifies the IsQATMoveBelowEnabled dependency property.
Declaration
public static readonly DependencyProperty IsQATMoveBelowEnabledProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the IsQATMoveBelowEnabled dependency property.
KeyTipProperty
Identifies Ribbon KeyTip attached dependency property. This is a dependency property.
Declaration
public static readonly DependencyProperty KeyTipProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
LayoutModeProperty
Identifies the LayoutMode dependency property.
Declaration
public static readonly DependencyProperty LayoutModeProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the LayoutMode dependency property.
MinimizeButtonVisibilityProperty
Identifies the MinimizeButtonVisibility Property used set RibbonMinimizebuttonVisibility dynamically.
Declaration
public static readonly DependencyProperty MinimizeButtonVisibilityProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
ModalTabCollectionProperty
Identifies collection of ribbon Modal Tabs. This is a dependency property.
Declaration
public static readonly DependencyProperty ModalTabCollectionProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
OptionTabsProperty
Identifies the OptionTabs dependency property.
Declaration
public static readonly DependencyProperty OptionTabsProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the OptionTabs dependency property.
QuickAccessToolBarProperty
Identifies Quick access ToolBar of the ribbon. This is a dependency property.
Declaration
public static readonly DependencyProperty QuickAccessToolBarProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RemoveItemFromQATProperty
Defines Add remove to QAT. This is a dependency property.
Declaration
public static readonly DependencyProperty RemoveItemFromQATProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RibbonBarCollapseImageProperty
Gets or Sets the Default RibbonBar Collapse Image.
Declaration
public static readonly DependencyProperty RibbonBarCollapseImageProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RibbonContextMenuClosingEvent
Raises when ribbon context menu closing.
Declaration
public static RoutedEvent RibbonContextMenuClosingEvent
Field Value
| Type |
|---|
| System.Windows.RoutedEvent |
RibbonContextMenuOpeningEvent
Raises when ribbon context menu opening. Handle=true avoid context menu opening.
Declaration
public static RoutedEvent RibbonContextMenuOpeningEvent
Field Value
| Type |
|---|
| System.Windows.RoutedEvent |
RibbonQATCommandTagProperty
Identifies the RibbonQATCommandTagProperty dependency property.
Declaration
public static readonly DependencyProperty RibbonQATCommandTagProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the RibbonQATCommandTagProperty dependency property.
RibbonStateProperty
Identifies Ribbon state. This is a dependency property.
Declaration
public static readonly DependencyProperty RibbonStateProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
ScreenTipStyleProperty
Declaration
public static readonly DependencyProperty ScreenTipStyleProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SelectedTabOnMergeProperty
Identifies the SelectedTabOnMerge dependency property.
Declaration
public static readonly DependencyProperty SelectedTabOnMergeProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the SelectedTabOnMerge dependency property.
ShowAboveRibbonProperty
Defines whether QAT is shown above ribbon. This is a dependency property.
Declaration
public static readonly DependencyProperty ShowAboveRibbonProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
ShowBelowRibbonProperty
Defines whether QAT is shown below ribbon. This is a dependency property.
Declaration
public static readonly DependencyProperty ShowBelowRibbonProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
ShowCustomizeRibbonProperty
Identifies the ShowCustomizeRibbon dependency property.
Declaration
public static readonly DependencyProperty ShowCustomizeRibbonProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the ShowCustomizeRibbon dependency property.
ShowDefaultQATKeyTipProperty
Identifies the ShowDefaultQATKeyTip dependency property.
Declaration
public static readonly DependencyProperty ShowDefaultQATKeyTipProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the ShowDefaultQATKeyTip dependency property.
ShowInMoreCommandsProperty
Identifies the ShowInMoreCommandsProperty dependency property.
Declaration
public static readonly DependencyProperty ShowInMoreCommandsProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the ShowInMoreCommandsProperty dependency property.
ShowOptionTabProperty
Identifies the ShowOptionTab dependency property.
Declaration
public static readonly DependencyProperty ShowOptionTabProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the ShowOptionTab dependency property.
SplitMenuKeyTipProperty
Represent the splitmenukey tip, this is a dependency property
Declaration
public static readonly DependencyProperty SplitMenuKeyTipProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
TabGroupLabelAlignmentProperty
Identifies the TabGroupLabelAlignment dependency property.
Declaration
public static readonly DependencyProperty TabGroupLabelAlignmentProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the TabGroupLabelAlignment dependency property.
TabPanelItemProperty
Identifies Ribbon TabPanel item. This is a dependency property.
Declaration
public static readonly DependencyProperty TabPanelItemProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Properties
AllowAdornerState
Gets or sets the Adorner state is allow or not.
Declaration
public bool AllowAdornerState { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
AllowKeyTip
Gets or sets whether the KeyTip need to display or not.
Declaration
public bool AllowKeyTip { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
ApplicationMenu
Gets or sets the ApplicationMenu to be displayed in the Ribbon control.
Declaration
public ApplicationMenu ApplicationMenu { get; set; }
Property Value
| Type | Description |
|---|---|
| ApplicationMenu | Type: ApplicationMenu ApplicationMenu control object. The default value is null. |
Remarks
When ApplicationMenu and BackStage properties assigned to Ribbon, then the ApplicationMenu will be shown while clicking the File button.
Examples
<syncfusion:RibbonWindow
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:syncfusion="http://schemas.syncfusion.com/wpf" x:Class="RibbonControl.MainWindow"
syncfusion:SkinStorage.VisualStyle="Default" >
<Grid>
<syncfusion:Ribbon x:Name="_ribbon" VerticalAlignment="Top">
<syncfusion:Ribbon.ApplicationMenu>
<syncfusion:ApplicationMenu Name = "applicationMenu" Width="38" Height="38" syncfusion:Ribbon.KeyTip="F" IsPopupOpen="False" ApplicationButtonImage="syncfusion.png">
</syncfusion:ApplicationMenu>
</syncfusion:Ribbon.ApplicationMenu>
</syncfusion:Ribbon>
</Grid>
</syncfusion:RibbonWindow>
ApplicationMenuHeader
Gets or sets the Application menu header
Declaration
public object ApplicationMenuHeader { get; set; }
Property Value
| Type |
|---|
| System.Object |
AutoPersist
Gets or sets a value indicating whether [save original state].
Declaration
public bool AutoPersist { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
BackStage
Gets or sets the back stage.
Declaration
public Backstage BackStage { get; set; }
Property Value
| Type | Description |
|---|---|
| Backstage | The back stage. |
BackStageButton
Gets or sets the Backstage button
Declaration
public BackStageButton BackStageButton { get; set; }
Property Value
| Type |
|---|
| BackStageButton |
BackStageColor
Gets or sets the Backstage color.
Declaration
public Brush BackStageColor { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.Brush |
BackStageCornerImageVisibility
Gets or sets the value Backstage Corner Image Visibility.
Declaration
public Visibility BackStageCornerImageVisibility { get; set; }
Property Value
| Type |
|---|
| System.Windows.Visibility |
BackStageHeader
Gets or sets the Backstage header
Declaration
public object BackStageHeader { get; set; }
Property Value
| Type |
|---|
| System.Object |
ContextAdornerStyle
Gets or sets the Context Adorner style
Declaration
public Style ContextAdornerStyle { get; set; }
Property Value
| Type |
|---|
| System.Windows.Style |
ContextGroupContainerStyle
Declaration
public Style ContextGroupContainerStyle { get; set; }
Property Value
| Type |
|---|
| System.Windows.Style |
ContextGroupSource
Declaration
public IEnumerable ContextGroupSource { get; set; }
Property Value
| Type |
|---|
| System.Collections.IEnumerable |
ContextTabGroups
Gets or sets the context tab groups.
Declaration
public ContextTabGroupCollection ContextTabGroups { get; set; }
Property Value
| Type | Description |
|---|---|
| ContextTabGroupCollection | Type: ContextTabGroupCollection The collection of ContextTabGroups. |
EnableMoreCommands
Gets or Sets the IsQATCustomizationDilogEnabled property.
Declaration
public bool EnableMoreCommands { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
EnableSimplifiedLayoutMode
Gets or sets the value that indicates whether the Ribbon will switch between its various LayoutMode values when clicking the ribbon minimize button. In Simplified mode, ribbon will arrange its items in single line allowing more screen space.
Declaration
public bool EnableSimplifiedLayoutMode { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | The System.Boolean value that is used to set the EnableSimplifiedLayoutMode. When set to |
Examples
Ribbon myRibbon = new Ribbon();
myRibbon. EnableSimplifiedLayoutMode = true;
FirstVisibleGroup
Gets the first visible group.
Declaration
protected ContextTabGroup FirstVisibleGroup { get; }
Property Value
| Type |
|---|
| ContextTabGroup |
HasVisibleContextTabGroup
Gets or sets a value indicating whether this instance has visible context tab group.
Declaration
protected bool HasVisibleContextTabGroup { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
IsBackStageVisible
Gets or sets a value to show or hide the BackStage.
Declaration
public bool IsBackStageVisible { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IsQATBelow
Gets or sets a value indicating whether this instance is QAT below.
Declaration
public bool IsQATBelow { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
IsQATContextMenuEnabled
Defines whether enable or disable the QAT context menu
Declaration
public bool IsQATContextMenuEnabled { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IsQATCustomizationEnabled
Defines whether enable or disable the QAT Customization
Declaration
public bool IsQATCustomizationEnabled { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IsQATMoveBelowEnabled
Defines whether enable or disable the QAT Move Below
Declaration
public bool IsQATMoveBelowEnabled { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
LastVisibleGroup
Gets the last visible group.
Declaration
protected ContextTabGroup LastVisibleGroup { get; }
Property Value
| Type | Description |
|---|---|
| ContextTabGroup | The last visible group. |
LayoutMode
Gets or sets the LayoutMode property that indicates whether the Ribbon is in normal or simplified mode.
When set to Simplified the Ribbon items will be arranged in a single line allowing more screen space.
Declaration
public LayoutMode LayoutMode { get; set; }
Property Value
| Type | Description |
|---|---|
| LayoutMode | The LayoutMode value that specifies whether the item is in Simplified or Normal mode. Default value is |
MinimizeButtonVisibility
Gets or sets the minimize button visibility.
Declaration
public Visibility MinimizeButtonVisibility { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Visibility | The minimize button visibility. |
ModalTabCollection
Gets or sets the modal tab collection.
Declaration
public ModalTabCollection ModalTabCollection { get; set; }
Property Value
| Type | Description |
|---|---|
| ModalTabCollection | The modal tab collection. |
OptionTabs
Gets or sets Option Tabs in Customization window.
Declaration
public ObservableCollection<OptionTab> OptionTabs { get; set; }
Property Value
| Type |
|---|
| System.Collections.ObjectModel.ObservableCollection<OptionTab> |
PersistElements
Gets or sets the persist elements.
Declaration
public ObservableCollection<RibbonElements> PersistElements { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.ObjectModel.ObservableCollection<RibbonElements> | The persist elements. |
QATCustomizationDialog
Gets or sets the QATCustomizationDialog of Ribbon to modify the button panel./>
Declaration
public QATCustomizationDialog QATCustomizationDialog { get; set; }
Property Value
| Type |
|---|
| QATCustomizationDialog |
QuickAccessToolBar
Gets or sets the QuickAccessToolBar of the Ribbon.
Declaration
public QuickAccessToolBar QuickAccessToolBar { get; set; }
Property Value
| Type | Description |
|---|---|
| QuickAccessToolBar | Type: QuickAccessToolBar QuickAccessToolBar control object. Default value is null. |
RibbonBarCollapseImage
Gets or sets the ribbon bar collapse image.
Declaration
public ImageSource RibbonBarCollapseImage { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Media.ImageSource | The ribbon bar collapse image. |
RibbonHeight
Gets oe sets the Height of the ribbon
Declaration
public double RibbonHeight { get; }
Property Value
| Type |
|---|
| System.Double |
RibbonState
Gets or sets the state of the ribbon.
Declaration
public RibbonState RibbonState { get; set; }
Property Value
| Type | Description |
|---|---|
| RibbonState | Type: RibbonState The state of the ribbon. |
SelectedTabItem
Gets or sets the selected tab item.
Declaration
public RibbonTab SelectedTabItem { get; }
Property Value
| Type | Description |
|---|---|
| RibbonTab | The selected tab item. |
SelectedTabOnMerge
Gets or sets the Ribbon tab to be merged on merging.
Declaration
public SelectedTabOnMerge SelectedTabOnMerge { get; set; }
Property Value
| Type |
|---|
| SelectedTabOnMerge |
ShowCustomizeRibbon
Gets or sets check whether the Customize ribbon is show or not.
Declaration
public bool ShowCustomizeRibbon { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
ShowDefaultQATKeyTip
Gets or sets the value check default QuickAccessToolBar KeyTip show.
Declaration
public bool ShowDefaultQATKeyTip { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
ShowOptionTab
Gets or sets a value that indicates whether to show the options tabs in QAT customization window.
Declaration
public bool ShowOptionTab { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if options tabs are shown in QAT customization window; otherwise, false.The default value is true. |
Remarks
This property works only when the items are present in the OptionTabs collection.
TabGroupLabelAlignment
Gets or sets the TabGroupLabel Alignment.
Declaration
public HorizontalAlignment TabGroupLabelAlignment { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.HorizontalAlignment | Type:System.Windows.Controls.Control The TabGroupLabel Alignment. |
TabPanelItem
Gets or sets the tab panel item.
Declaration
public Control TabPanelItem { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Controls.Control | Type: System.Windows.Controls.Control The tab panel item. |
Methods
AddElementToQAT(String)
Declaration
public bool AddElementToQAT(string element)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | element |
Returns
| Type |
|---|
| System.Boolean |
AddElementToQAT(String, AdditionType)
Declaration
public bool AddElementToQAT(string element, AdditionType QATAdditionType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | element | |
| AdditionType | QATAdditionType |
Returns
| Type |
|---|
| System.Boolean |
AddItem(RibbonTab, RibbonDynamicItemInfo)
Declaration
public void AddItem(RibbonTab tab, RibbonDynamicItemInfo dynamiciteminfo)
Parameters
| Type | Name | Description |
|---|---|---|
| RibbonTab | tab | |
| RibbonDynamicItemInfo | dynamiciteminfo |
CloseModalTabs()
Closes the modal tabs.
Declaration
public bool CloseModalTabs()
Returns
| Type |
|---|
| System.Boolean |
DeleteRibbonState()
Deletes the state of the ribbon.
Declaration
public void DeleteRibbonState()
DeleteRibbonState(IsolatedStorageFile, String)
Deletes the state of the ribbon.
Declaration
public void DeleteRibbonState(IsolatedStorageFile isoStorage, string deleteFileName)
Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.IsolatedStorage.IsolatedStorageFile | isoStorage | The iso storage. |
| System.String | deleteFileName | Name of the delete file. |
Dispose()
Disposes the unmanaged resources of Ribbon.
Declaration
public void Dispose()
FireAfterQatDropDownPopup()
Fires the after qat drop down popup.
Declaration
protected virtual void FireAfterQatDropDownPopup()
FireBackStageClosing(CancelEventArgs)
Fires when from cache Backstage closing event
Declaration
protected virtual void FireBackStageClosing(CancelEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.ComponentModel.CancelEventArgs | e |
FireBackStageOpening(CancelEventArgs)
Fires when Backstage opening
Declaration
protected void FireBackStageOpening(CancelEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.ComponentModel.CancelEventArgs | e | The event data |
FireBeforeQatDropDownPopup(CancelEventArgs)
Fires the before qat drop down popup.
Declaration
protected virtual void FireBeforeQatDropDownPopup(CancelEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.ComponentModel.CancelEventArgs | e | The instance containing the event data. |
FireQATCustomizeDialogClosed(QATCustomizationDialog)
Fires the QAT customize dialog closed.
Declaration
protected virtual void FireQATCustomizeDialogClosed(QATCustomizationDialog dialog)
Parameters
| Type | Name | Description |
|---|---|---|
| QATCustomizationDialog | dialog |
FireQATCustomizeDialogOpening(CancelEventArgs)
Fires the QAT customize dialog opening.
Declaration
protected virtual void FireQATCustomizeDialogOpening(CancelEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.ComponentModel.CancelEventArgs | e | The instance containing the event data. |
FireQATItemsCollectionChanged(QATItemsCollectionChangedEventArgs)
Fires the QAT items collection changed.
Declaration
protected virtual void FireQATItemsCollectionChanged(QATItemsCollectionChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| QATItemsCollectionChangedEventArgs | e | The instance containing the event data. |
FireRibbonStateLoaded(EventArgs)
Fires Dynamic Items Load.
Declaration
protected virtual void FireRibbonStateLoaded(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e |
GetActiveColorScheme(DependencyObject)
Gets the value of the ActiveColorScheme property for a given element.
Declaration
public static object GetActiveColorScheme(DependencyObject obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The element for which to retrieve the ZIndex value. |
Returns
| Type | Description |
|---|---|
| System.Object | returns Active Color Scheme Property |
GetAllowCloneItems(DependencyObject)
Gets the value check the Clone items allow.
Declaration
public static bool GetAllowCloneItems(DependencyObject obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The dependency object |
Returns
| Type | Description |
|---|---|
| System.Boolean | True or false |
GetBindableChildren(UIElement)
Gets the BindableChildrenProperty to initialize the children of the System.Windows.Controls.Grid.
Declaration
public static object GetBindableChildren(UIElement element)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.UIElement | element | The System.Windows.Controls.Grid used to initialize the children. |
Returns
| Type | Description |
|---|---|
| System.Object | The items collection to populate the children of System.Windows.Controls.Grid. |
GetContainerForItemOverride()
Creates or identifies the element that is used to display the given item.
Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
| Type | Description |
|---|---|
| System.Windows.DependencyObject | The element that is used to display the given item. |
GetDynamicItem(DependencyObject)
Gets the value check dynamic item or not.
Declaration
public static bool GetDynamicItem(DependencyObject obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The dependency object |
Returns
| Type | Description |
|---|---|
| System.Boolean | The dynamic item |
GetDynamicItemTag(DependencyObject)
Gets the value for dynamic item tag
Declaration
public static string GetDynamicItemTag(DependencyObject obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The dependency object |
Returns
| Type | Description |
|---|---|
| System.String | The dynamic item tag |
GetIsAutoSizeFormEnabled(DependencyObject)
Gets the is auto size form enabled.
Declaration
public static bool GetIsAutoSizeFormEnabled(DependencyObject obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The obj. |
Returns
| Type |
|---|
| System.Boolean |
GetIsQATItem(DependencyObject)
Gets the value of the IsQATItem property for a given element.
Declaration
public static bool GetIsQATItem(DependencyObject obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The element for which to retrieve the IsQATItem value. |
Returns
| Type | Description |
|---|---|
| System.Boolean | return Is QATItem Property |
GetKeyTip(DependencyObject)
Gets the key tip.
Declaration
public static string GetKeyTip(DependencyObject obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The obj value. |
Returns
| Type | Description |
|---|---|
| System.String | string value |
GetQatItemsSources()
It returns QAT items
Declaration
public List<UIElement> GetQatItemsSources()
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.Windows.UIElement> | The list |
GetRibbonQATCommandTag(DependencyObject)
Gets the Ribbon QuickAccessToolBar command tag
Declaration
public static object GetRibbonQATCommandTag(DependencyObject obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The dependency object |
Returns
| Type | Description |
|---|---|
| System.Object | The command tag |
GetSerializedList(XmlReader)
Gets the serialized List of Ribbon state.
Declaration
public RibbonStateParams GetSerializedList(XmlReader xmlReader)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Xml.XmlReader | xmlReader | The XML Reader |
Returns
| Type |
|---|
| RibbonStateParams |
GetShowInMoreCommands(DependencyObject)
Gets the value check the show in more commands
Declaration
public static bool GetShowInMoreCommands(DependencyObject obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The dependency object |
Returns
| Type | Description |
|---|---|
| System.Boolean | True or false |
GetSplitMenuKeyTip(DependencyObject)
Gets the split menu key tip.
Declaration
public static string GetSplitMenuKeyTip(DependencyObject obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The obj. |
Returns
| Type |
|---|
| System.String |
HideBackStage()
Hides the back stage.
Declaration
public void HideBackStage()
HideKeyTip()
Invoked when Hides the keyTip
Declaration
public void HideKeyTip()
IsItemItsOwnContainerOverride(Object)
Determines if the specified item is (or is eligible to be) its own container.
Declaration
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | item | The item to check. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns true if the item is (or is eligible to be) its own container; otherwise, false. |
LoadDynamicItems(RibbonDynamicItemInfo)
Load dynamic item information
Declaration
public void LoadDynamicItems(RibbonDynamicItemInfo oldtabdynamicinfo)
Parameters
| Type | Name | Description |
|---|---|---|
| RibbonDynamicItemInfo | oldtabdynamicinfo |
Merge(Ribbon)
Used to merge the child ribbon with the parent ribbon.
Declaration
public void Merge(Ribbon ribbon)
Parameters
| Type | Name | Description |
|---|---|---|
| Ribbon | ribbon | Child ribbon to be merged. |
OnAllowKeyTipChanged(DependencyPropertyChangedEventArgs)
Declaration
protected virtual void OnAllowKeyTipChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyPropertyChangedEventArgs | e |
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate.
Declaration
public override void OnApplyTemplate()
OnCreateAutomationPeer()
Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation infrastructure.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
| Type | Description |
|---|---|
| System.Windows.Automation.Peers.AutomationPeer | The type-specific AutomationPeer implementation. |
OnHasVisibleContextTabGroupChanged(DependencyPropertyChangedEventArgs)
Updates property value cache and raises HasVisibleContextTabGroupChanged event.
Declaration
protected virtual void OnHasVisibleContextTabGroupChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyPropertyChangedEventArgs | e | Property changes details, such as old value and new value. |
OnInitialized(EventArgs)
Raises the Initialized event. This method is invoked whenever IsInitialized is set to true internally.
Declaration
protected override void OnInitialized(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | The EventArgs that contains the event data. |
OnIsQATBelowChanged(DependencyPropertyChangedEventArgs)
Updates property value cache and raises IsQATBelowChanged event.
Declaration
protected virtual void OnIsQATBelowChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyPropertyChangedEventArgs | e | Property change details, such as old value and new value. |
OnItemsChanged(NotifyCollectionChangedEventArgs)
Invoked when the Items property changes.
Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Specialized.NotifyCollectionChangedEventArgs | e | Information about the change. |
OnItemsSourceChanged(IEnumerable, IEnumerable)
Called when the source of an item in a selector changes.
Declaration
protected override void OnItemsSourceChanged(IEnumerable oldValue, IEnumerable newValue)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.IEnumerable | oldValue | Old value of the source. |
| System.Collections.IEnumerable | newValue | New value of the source. |
OnItemTemplateChanged(DataTemplate, DataTemplate)
Invoked when the System.Windows.Controls.ItemsControl.ItemTemplate property changes.
Declaration
protected override void OnItemTemplateChanged(DataTemplate oldItemTemplate, DataTemplate newItemTemplate)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DataTemplate | oldItemTemplate | The old System.Windows.Controls.ItemsControl.ItemTemplate property value. |
| System.Windows.DataTemplate | newItemTemplate | The new System.Windows.Controls.ItemsControl.ItemTemplate property value. |
OnLostKeyboardFocus(KeyboardFocusChangedEventArgs)
Invoked when an unhandled System.Windows.Input.Keyboard.LostKeyboardFocusattached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
Declaration
protected override void OnLostKeyboardFocus(KeyboardFocusChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.KeyboardFocusChangedEventArgs | e | The System.Windows.Input.KeyboardFocusChangedEventArgsthat contains event data. |
OnMouseRightButtonUp(MouseButtonEventArgs)
Invoked when an unhandled System.Windows.UIElement.MouseRightButtonUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
Declaration
protected override void OnMouseRightButtonUp(MouseButtonEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseButtonEventArgs | e | The System.Windows.Input.MouseButtonEventArgs that contains the event data. The event data reports that the right mouse button was released. |
OnMouseWheel(MouseWheelEventArgs)
Invoked when an unhandled System.Windows.Input.Mouse.MouseWheelattached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
Declaration
protected override void OnMouseWheel(MouseWheelEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseWheelEventArgs | e | The System.Windows.Input.MouseWheelEventArgsthat contains the event data. |
OnPreviewTouchDown(TouchEventArgs)
Provides class handling for the PreviewTouchDown routed event that occurs when a touch presses this element.
Declaration
protected override void OnPreviewTouchDown(TouchEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.TouchEventArgs | e | The Event data |
OnPropertyChanged(DependencyPropertyChangedEventArgs)
Occurs when properties changes.
Declaration
protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyPropertyChangedEventArgs | e | The event data |
OnRibbonStateChanged(DependencyPropertyChangedEventArgs)
Updates property value cache and raises RibbonStateChanged event.
Declaration
protected virtual void OnRibbonStateChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyPropertyChangedEventArgs | e | Property changes details, such as old value and new value. |
OnSelectedIndexChanged(DependencyPropertyChangedEventArgs)
Raises the SelectedIndexChanged event.
Declaration
protected virtual void OnSelectedIndexChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyPropertyChangedEventArgs | e | The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data. |
OnStylusSystemGesture(StylusSystemGestureEventArgs)
Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation infrastructure.
Declaration
protected override void OnStylusSystemGesture(StylusSystemGestureEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.StylusSystemGestureEventArgs | e |
OnTabPanelItemChanged(DependencyPropertyChangedEventArgs)
Updates property value cache and raises TabPanelItemChanged event.
Declaration
protected virtual void OnTabPanelItemChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyPropertyChangedEventArgs | e | Property changes details, such as old value and new value. |
OnTouchUp(TouchEventArgs)
Provides class handling for the PreviewTouchUp routed event that occurs when a touch is released inside this element.
Declaration
protected override void OnTouchUp(TouchEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.TouchEventArgs | e | The event data |
PrepareContainerForItemOverride(DependencyObject, Object)
Prepare Container for the particular item.
Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | element | The container element used to display the given item. |
| System.Object | item | The item for which the container has to be prepared. |
RemoveElementFromQAT(String)
Declaration
public bool RemoveElementFromQAT(string element)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | element |
Returns
| Type |
|---|
| System.Boolean |
RemoveElementFromQAT(String, RemoveType)
Declaration
public bool RemoveElementFromQAT(string element, RemoveType QATRemoveType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | element | |
| RemoveType | QATRemoveType |
Returns
| Type |
|---|
| System.Boolean |
ResetQATKeyTips()
Clears existing KeyTips for QAT items and generates new KeyTips.
Declaration
public void ResetQATKeyTips()
ResetRibbonState()
Resets the state of the ribbon.
Declaration
public void ResetRibbonState()
Ribbon_Click(Object, RoutedEventArgs)
Handles click on ribbon adorner.
Declaration
public void Ribbon_Click(object sender, RoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | Ribbon button. |
| System.Windows.RoutedEventArgs | e | The instance of RoutedEventArgs object. |
SetActiveColorScheme(DependencyObject, Object)
Sets the value of the ActiveColorScheme property for a given element.
Declaration
public static void SetActiveColorScheme(DependencyObject obj, object value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The element on which to apply the property value. |
| System.Object | value | Active scheme brush. |
SetAllowCloneItems(DependencyObject, Boolean)
Sets the value check the clone items allow
Declaration
public static void SetAllowCloneItems(DependencyObject obj, bool value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The dependency object |
| System.Boolean | value | The value |
SetBindableChildren(UIElement, Object)
Sets the BindableChildrenProperty to initialize the children of the System.Windows.Controls.Grid.
Declaration
public static void SetBindableChildren(UIElement element, object value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.UIElement | element | The System.Windows.Controls.Grid used to initialize the children. |
| System.Object | value | The items collection to populate the children of System.Windows.Controls.Grid. |
SetDynamicItem(DependencyObject, Boolean)
Sets the dynamic item.
Declaration
public static void SetDynamicItem(DependencyObject obj, bool value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The dependency object |
| System.Boolean | value | The value |
SetDynamicItemTag(DependencyObject, String)
Sets the dynamic item tag.
Declaration
public static void SetDynamicItemTag(DependencyObject obj, string value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The dependency object |
| System.String | value | The value |
SetIsAutoSizeFormEnabled(DependencyObject, Boolean)
Sets the is auto size form enabled.
Declaration
public static void SetIsAutoSizeFormEnabled(DependencyObject obj, bool value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The obj. |
| System.Boolean | value | if set to |
SetIsQATItem(DependencyObject, Boolean)
Sets the value of the IsQATItem property for a given element.
Declaration
public static void SetIsQATItem(DependencyObject obj, bool value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The element on which to apply the property value. |
| System.Boolean | value | IsQATItem Boolean value. |
SetKeyTip(DependencyObject, String)
Sets the value of the KeyTip property for a given element.
Declaration
public static void SetKeyTip(DependencyObject obj, string value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The element on which to apply the property value. |
| System.String | value | Key tip value. |
SetRibbonQATCommandTag(DependencyObject, Object)
Sets the Ribbon QuickAccessToolBar Command tag
Declaration
public static void SetRibbonQATCommandTag(DependencyObject obj, object value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The dependency object |
| System.Object | value | The value |
SetShowInMoreCommands(DependencyObject, Boolean)
Sets the value check the show in more commands
Declaration
public static void SetShowInMoreCommands(DependencyObject obj, bool value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The dependency object |
| System.Boolean | value | The value |
SetSplitMenuKeyTip(DependencyObject, String)
Sets the split menu key tip.
Declaration
public static void SetSplitMenuKeyTip(DependencyObject obj, string value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | The object. |
| System.String | value | The value. |
ShowBackStage()
Shows the back stage.
Declaration
public void ShowBackStage()
ShowCustomizationDialog()
Shows Customization Dialog.
Declaration
public void ShowCustomizationDialog()
ShowModalTab(String)
Shows the modal tab.
Declaration
public bool ShowModalTab(string ribbonTabName)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | ribbonTabName | Name of the ribbon tab. |
Returns
| Type |
|---|
| System.Boolean |
UnMerge()
Used to unmerge all child ribbon from parent ribbon.
Declaration
public void UnMerge()
UnMerge(Ribbon)
Used to unmerge child ribbon from parent ribbon.
Declaration
public void UnMerge(Ribbon ribbonToRemove)
Parameters
| Type | Name | Description |
|---|---|---|
| Ribbon | ribbonToRemove | Child ribbon needs to remove |
Events
AfterQatDropDownPopup
Occurs after QAT DropDown popup is opened.
Declaration
public event EventHandler AfterQatDropDownPopup
Event Type
| Type |
|---|
| System.EventHandler |
BackStageClosed
Event that is raised after BackStage is closed.
Declaration
public event EventHandler BackStageClosed
Event Type
| Type |
|---|
| System.EventHandler |
BackStageClosing
Cancelable event that is raised before BackStage is closing.
Declaration
public event CancelEventHandler BackStageClosing
Event Type
| Type |
|---|
| System.ComponentModel.CancelEventHandler |
BackStageOpened
Event that is raised after BackStage is opened.
Declaration
public event EventHandler BackStageOpened
Event Type
| Type |
|---|
| System.EventHandler |
BackStageOpening
Cancelable event that is raised before BackStage is opening.
Declaration
public event CancelEventHandler BackStageOpening
Event Type
| Type |
|---|
| System.ComponentModel.CancelEventHandler |
BeforeQatDropDownPopup
Occurs before QAT DropDown popup is opened.
Declaration
public event CancelEventHandler BeforeQatDropDownPopup
Event Type
| Type |
|---|
| System.ComponentModel.CancelEventHandler |
HasVisibleContextTabGroupChanged
Event that is raised when HasVisibleContextTabGroup property is changed.
Declaration
public event PropertyChangedCallback HasVisibleContextTabGroupChanged
Event Type
| Type |
|---|
| System.Windows.PropertyChangedCallback |
IsQATBelowChanged
Event that is raised after IsQATBelow property is changed.
Declaration
public event PropertyChangedCallback IsQATBelowChanged
Event Type
| Type |
|---|
| System.Windows.PropertyChangedCallback |
LayoutModeChanged
Occurs when LayoutMode property is changed.
Declaration
public event EventHandler LayoutModeChanged
Event Type
| Type |
|---|
| System.EventHandler |
QATCustomizeDialogClosed
Event that is raised after QATCustomizeDialog is closed.
Declaration
public event EventHandler QATCustomizeDialogClosed
Event Type
| Type |
|---|
| System.EventHandler |
QATCustomizeDialogOpening
Cancelable event that is raised before QATCustomizeDialog is opening.
Declaration
public event CancelEventHandler QATCustomizeDialogOpening
Event Type
| Type |
|---|
| System.ComponentModel.CancelEventHandler |
QATDialogTabSelectionChanged
Event that raises when the QAT dialog tab selection changes
Declaration
public event SelectionChangedEventHandler QATDialogTabSelectionChanged
Event Type
| Type |
|---|
| System.Windows.Controls.SelectionChangedEventHandler |
QATItemsCollectionChanged
Occurs when item is added or removed from QAT.
Declaration
public event QATItemsCollectionChangedEventHandler QATItemsCollectionChanged
Event Type
| Type |
|---|
| QATItemsCollectionChangedEventHandler |
RibbonContextMenuClosing
Event that is raised when RibbonContextMenu is closing.
Declaration
public event ContextMenuEventHandler RibbonContextMenuClosing
Event Type
| Type |
|---|
| System.Windows.Controls.ContextMenuEventHandler |
RibbonContextMenuOpening
Event that is raised when RibbonContextMenu is Opening.
Declaration
public event ContextMenuEventHandler RibbonContextMenuOpening
Event Type
| Type |
|---|
| System.Windows.Controls.ContextMenuEventHandler |
RibbonStateChanged
Event that is raised when RibbonState property is changed.
Declaration
public event PropertyChangedCallback RibbonStateChanged
Event Type
| Type |
|---|
| System.Windows.PropertyChangedCallback |
SelectedIndexChanged
Event that is raised when SelectedIndex property is changed.
Declaration
public event PropertyChangedCallback SelectedIndexChanged
Event Type
| Type |
|---|
| System.Windows.PropertyChangedCallback |
SelectionChanging
Cancelable event that is raised before the RibbonTab is selected.
Declaration
public event CancelEventHandler SelectionChanging
Event Type
| Type |
|---|
| System.ComponentModel.CancelEventHandler |
TabPanelItemChanged
Event that is raised when TabPanelItem property is changed.
Declaration
public event PropertyChangedCallback TabPanelItemChanged
Event Type
| Type |
|---|
| System.Windows.PropertyChangedCallback |