RadRibbonView
Represents a ribbon-style control that provides a user interface for organizing commands into tabs and groups.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.RibbonView.dll
Syntax:
[TelerikToolboxCategory("Navigation")]
[Themable]
public class RadRibbonView : RadTabControlBase
Inheritance: objectRadTabControlBaseRadRibbonView
Derived Classes:
Inherited Members
Constructors
Initializes a new instance of the RadRibbonView class.
public RadRibbonView()
Fields
ApplicationButtonContentProperty
DependencyProperty
Identifies the ApplicationButtonContent property.
public static readonly DependencyProperty ApplicationButtonContentProperty
ApplicationButtonDoubleClickEvent
RoutedEvent
Identifies the ApplicationButtonDoubleClick routed event.
public static readonly RoutedEvent ApplicationButtonDoubleClickEvent
ApplicationButtonImageSourceProperty
DependencyProperty
Identifies the ApplicationButtonImageSource property.
public static readonly DependencyProperty ApplicationButtonImageSourceProperty
ApplicationButtonStyleProperty
DependencyProperty
Identifies the ApplicationButtonStyleProperty property.
public static readonly DependencyProperty ApplicationButtonStyleProperty
ApplicationButtonVisibilityProperty
DependencyProperty
Identifies the ApplicationButtonVisibility property.
public static readonly DependencyProperty ApplicationButtonVisibilityProperty
ApplicationMenuOpenStateChangedEvent
RoutedEvent
Identifies the ApplicationMenuOpenStateChanged routed event.
public static readonly RoutedEvent ApplicationMenuOpenStateChangedEvent
ApplicationMenuProperty
DependencyProperty
Identifies the ApplicationMenu property.
public static readonly DependencyProperty ApplicationMenuProperty
ApplicationNameProperty
DependencyProperty
Identifies the ApplicationName property.
public static readonly DependencyProperty ApplicationNameProperty
BackstageClippingElementProperty
DependencyProperty
Identifies the BackstageClippingElement dependency property.
public static readonly DependencyProperty BackstageClippingElementProperty
BackstageProperty
DependencyProperty
Identifies the Backstage property.
public static readonly DependencyProperty BackstageProperty
CollapsedChangedEvent
RoutedEvent
Identifies the CollapsedChanged routed event.
public static readonly RoutedEvent CollapsedChangedEvent
CollapseThresholdSizeProperty
DependencyProperty
Identifies the CollapseThresholdSize property.
public static readonly DependencyProperty CollapseThresholdSizeProperty
ContentHeightProperty
DependencyProperty
Identifies the ContentHeight property.
public static readonly DependencyProperty ContentHeightProperty
ContextualGroupsItemsSourceProperty
DependencyProperty
Identifies the ContextualGroupsItemsSource property.
public static readonly DependencyProperty ContextualGroupsItemsSourceProperty
ContextualGroupsProperty
DependencyProperty
Identifies the ContextualGroupsProperty.
public static readonly DependencyProperty ContextualGroupsProperty
ContextualGroupsStyleProperty
DependencyProperty
Identifies the ContextualGroupsStyleProperty property.
public static readonly DependencyProperty ContextualGroupsStyleProperty
ContextualTabsStyleProperty
DependencyProperty
Identifies the ContextualTabsStyleProperty property.
public static readonly DependencyProperty ContextualTabsStyleProperty
HelpButtonImageSourceProperty
DependencyProperty
Identifies the HelpButtonImageSource property.
public static readonly DependencyProperty HelpButtonImageSourceProperty
HelpButtonStyleProperty
DependencyProperty
Identifies the HelpButtonStyleProperty property.
public static readonly DependencyProperty HelpButtonStyleProperty
HelpButtonVisibilityProperty
DependencyProperty
Identifies the HelpButtonVisibility property.
public static readonly DependencyProperty HelpButtonVisibilityProperty
HelpCommandParameterProperty
DependencyProperty
Identifies the HelpCommandParameter dependency property.
public static readonly DependencyProperty HelpCommandParameterProperty
HelpCommandProperty
DependencyProperty
Identifies the HelpCommand dependency property.
public static readonly DependencyProperty HelpCommandProperty
HelpCommandTargetProperty
DependencyProperty
Identifies the HelpCommandTarget dependency property.
public static readonly DependencyProperty HelpCommandTargetProperty
HelpRequestedEvent
RoutedEvent
Identifies the HelpRequested routed event.
public static readonly RoutedEvent HelpRequestedEvent
IsApplicationButtonEnabledProperty
DependencyProperty
Identifies the IsApplicationButtonEnabled property.
public static readonly DependencyProperty IsApplicationButtonEnabledProperty
IsApplicationMenuOpenProperty
DependencyProperty
Identifies the IsApplicationMenuOpen property.
public static readonly DependencyProperty IsApplicationMenuOpenProperty
IsBackstageOpenProperty
DependencyProperty
Identifies the IsBackstageOpen property.
public static readonly DependencyProperty IsBackstageOpenProperty
IsCollapsedProperty
DependencyProperty
Identifies the IsMinimized property.
public static readonly DependencyProperty IsCollapsedProperty
IsHostedInRibbonWindowProperty
DependencyProperty
Identifies the IsHostedInRibbonWindow property.
public static readonly DependencyProperty IsHostedInRibbonWindowProperty
IsMinimizableProperty
DependencyProperty
Identifies the IsMinimizable property.
public static readonly DependencyProperty IsMinimizableProperty
IsMinimizedPopupOpenProperty
DependencyProperty
Identifies the IsMinimizedPopupOpen property.
public static readonly DependencyProperty IsMinimizedPopupOpenProperty
IsMinimizedProperty
DependencyProperty
Identifies the IsMinimized property.
public static readonly DependencyProperty IsMinimizedProperty
IsMouseWheelTabScrollingEnabledProperty
DependencyProperty
Identifies the IsMouseWheelTabScrollingEnabled property.
public static readonly DependencyProperty IsMouseWheelTabScrollingEnabledProperty
LayoutModeButtonContentProperty
DependencyProperty
Identifies the LayoutModeButtonContent property.
public static readonly DependencyProperty LayoutModeButtonContentProperty
LayoutModeChangedEvent
RoutedEvent
Identifies the LayoutModeChanged routed event.
public static readonly RoutedEvent LayoutModeChangedEvent
LayoutModeProperty
DependencyProperty
Identifies the LayoutMode property.
public static readonly DependencyProperty LayoutModeProperty
MinimizeButtonStyleProperty
DependencyProperty
Identifies the MinimizeButtonStyleProperty property.
public static readonly DependencyProperty MinimizeButtonStyleProperty
MinimizeButtonVisibilityProperty
DependencyProperty
Identifies the MinimizeButtonVisibility property.
public static readonly DependencyProperty MinimizeButtonVisibilityProperty
MinimizedChangedEvent
RoutedEvent
Identifies the MinimizedChanged routed event.
public static readonly RoutedEvent MinimizedChangedEvent
MinimizedPopupStateChangedEvent
RoutedEvent
Identifies the MinimizedPopupStateChanged routed event.
public static readonly RoutedEvent MinimizedPopupStateChangedEvent
PopupOpenedEvent
RoutedEvent
Identifies the PopupOpened routed event.
public static readonly RoutedEvent PopupOpenedEvent
PreviewMinimizedChangedEvent
RoutedEvent
Identifies the PreviewMinimizedChanged routed event.
public static readonly RoutedEvent PreviewMinimizedChangedEvent
PreviewPopupOpenedEvent
RoutedEvent
Identifies the PreviewPopupOpened routed event.
public static readonly RoutedEvent PreviewPopupOpenedEvent
QuickAccessToolBarPositionProperty
DependencyProperty
Identifies the QuickAccessToolBarPosition property.
public static readonly DependencyProperty QuickAccessToolBarPositionProperty
QuickAccessToolBarProperty
DependencyProperty
Identifies the QuickAccessToolBar property.
public static readonly DependencyProperty QuickAccessToolBarProperty
RibbonGroupsPresenterStyleProperty
DependencyProperty
Identifies the RibbonGroupsPresenterStyleProperty property.
public static readonly DependencyProperty RibbonGroupsPresenterStyleProperty
SelectedTabProperty
DependencyProperty
Identifies the SelectedTab property.
public static readonly DependencyProperty SelectedTabProperty
ShowLayoutModeButtonProperty
DependencyProperty
Identifies the ShowLayoutModeButton property.
public static readonly DependencyProperty ShowLayoutModeButtonProperty
SimplifiedContentHeightProperty
DependencyProperty
Identifies the SimplifiedContentHeight property.
public static readonly DependencyProperty SimplifiedContentHeightProperty
SimplifiedItemTemplateProperty
DependencyProperty
Identifies the SimplifiedItemTemplate property.
public static readonly DependencyProperty SimplifiedItemTemplateProperty
TabStripAdditionalContentProperty
DependencyProperty
Identifies the TabStripAdditionalContent property.
public static readonly DependencyProperty TabStripAdditionalContentProperty
TitleBarBackgroundProperty
DependencyProperty
Identifies the TitleBarBackground property.
public static readonly DependencyProperty TitleBarBackgroundProperty
TitleBarVisibilityProperty
DependencyProperty
Identifies the TitleBarVisibility property.
public static readonly DependencyProperty TitleBarVisibilityProperty
TitleProperty
DependencyProperty
Identifies the Title property.
public static readonly DependencyProperty TitleProperty
ToolBarPositionChangedEvent
RoutedEvent
Identifies the ToolBarPositionChanged routed event.
public static readonly RoutedEvent ToolBarPositionChangedEvent
WindowIconVisibilityProperty
DependencyProperty
Identifies the WindowIconVisibility property.
public static readonly DependencyProperty WindowIconVisibilityProperty
WindowTitleStyleProperty
DependencyProperty
Identifies the WindowTitleStyleProperty property.
public static readonly DependencyProperty WindowTitleStyleProperty
Properties
Gets or sets the application button content. Use this property or ApplicationButtonImageSource property to set the content of the application button.
public object ApplicationButtonContent { get; set; }
The application button image source.
ApplicationButtonImageSource
ImageSource
Gets or sets the application button image source.
public ImageSource ApplicationButtonImageSource { get; set; }
The application button image source.
Gets or sets the ApplicationButton style.
public Style ApplicationButtonStyle { get; set; }
The ApplicationButtonStyle.
ApplicationButtonVisibility
Visibility
Gets or sets the application button Visibility.
public Visibility ApplicationButtonVisibility { get; set; }
The application button Visibility.
Gets or sets the application menu.
public ApplicationMenu ApplicationMenu { get; set; }
The application menu.
Gets or sets the name of the application.
public string ApplicationName { get; set; }
The name of the application.
Gets or sets the backstage.
public RadRibbonBackstage Backstage { get; set; }
The backstage.
BackstageClippingElement
FrameworkElement
Gets or sets the area that will contain the backstage.
public FrameworkElement BackstageClippingElement { get; set; }
Gets or sets the size under which the RadRibbonView is collapsing.
public Size CollapseThresholdSize { get; set; }
Gets or sets the ContentHeight property.
public double ContentHeight { get; set; }
Gets the ContextualGroups property.
public ContextualGroupCollection ContextualGroups { get; }
Gets or sets the ContextualGroupsItemsSource.
public IEnumerable ContextualGroupsItemsSource { get; set; }
Gets or sets the contextual group's style.
public Style ContextualGroupsStyle { get; set; }
The ContextualGroupsStyle.
ContextualTabsStyle
Style
Gets or sets the contextual tab's style.
public Style ContextualTabsStyle { get; set; }
The ContextualTabsStyle.
HelpButtonImageSource
ImageSource
Gets or sets the help button image source.
public ImageSource HelpButtonImageSource { get; set; }
HelpButtonStyle
Style
Gets or sets the HelpButton style.
public Style HelpButtonStyle { get; set; }
The HelpButtonStyle.
HelpButtonVisibility
Visibility
Gets or sets the help button visibility.
public Visibility HelpButtonVisibility { get; set; }
The help button visibility.
Gets or sets the command that will be executed when the command source is invoked.
public ICommand HelpCommand { get; set; }
Represents a user defined data value that can be passed to the command when it is executed.
public object HelpCommandParameter { get; set; }
HelpCommandTarget
UIElement
The object that the command is being executed on.
public UIElement HelpCommandTarget { get; set; }
Gets or sets a value indicating whether the ribbon bar's backstage/application button is enabled.
public bool IsApplicationButtonEnabled { get; set; }
Gets or sets a value indicating whether this instance is application menu open.
public bool IsApplicationMenuOpen { get; set; }
Gets or sets a value indicating whether the ribbon bar's backstage is open.
public bool IsBackstageOpen { get; set; }
Gets a value indicating whether the RibbonView is collapsed due to insufficient space.
public bool IsCollapsed { get; }
Gets a value indicating whether this instance is hosted in ribbon window.
public bool IsHostedInRibbonWindow { get; }
True if this instance is hosted in ribbon window; otherwise, false.
Gets or sets a value indicating whether the RibbonView is Minimizable.
public bool IsMinimizable { get; set; }
Gets or sets a value indicating whether the RibbonView is minimized.
public bool IsMinimized { get; set; }
Gets a value indicating whether the popup for the minimized state is open.
public bool IsMinimizedPopupOpen { get; }
Gets or sets a value indicating whether the mouse wheel will switch between the tabs.
public bool IsMouseWheelTabScrollingEnabled { get; set; }
Gets or sets a value indicating the layout render mode of the control.
public RibbonLayout LayoutMode { get; set; }
Gets or sets the ribbon layout button content.
public object LayoutModeButtonContent { get; set; }
MinimizeButtonStyle
Style
Gets or sets the MinimizeButton style.
public Style MinimizeButtonStyle { get; set; }
The MinimizeButtonStyle.
MinimizeButtonVisibility
Visibility
Gets or sets the Visibility of the minimize button which is located near the help button.
public Visibility MinimizeButtonVisibility { get; set; }
Gets or sets the QuickAccessToolBar.
public QuickAccessToolBar QuickAccessToolBar { get; set; }
The QuickAccessToolBar.
Gets or sets the quick access toolbar position.
public QuickAccessToolBarPosition QuickAccessToolBarPosition { get; set; }
The quick access toolbar position.
Gets or sets the RibbonGroupsPresenter style.
public Style RibbonGroupsPresenterStyle { get; set; }
The RibbonGroupsPresenterStyle.
Gets the currently selected tab, representing the SelectedItem.
public RadRibbonTab SelectedTab { get; }
Gets or sets a value indicating whether the button which controls the ribbon layout is visible.
public bool ShowLayoutModeButton { get; set; }
Gets or sets the SimplifiedContentHeight property.
public double SimplifiedContentHeight { get; set; }
SimplifiedItemTemplate
DataTemplate
Gets or sets the DataTemplate used to display an item in Simplified layout.
public DataTemplate SimplifiedItemTemplate { get; set; }
Gets or sets content that is displayed at the right end of the tab strip.
public object TabStripAdditionalContent { get; set; }
TitleBarBackground
Brush
Gets or sets the background of the title bar.
public Brush TitleBarBackground { get; set; }
TitleBarVisibility
Visibility
Gets or sets the title bar Visibility.
public Visibility TitleBarVisibility { get; set; }
The title bar Visibility.
WindowIconVisibility
Visibility
Gets or sets the window icon visibility.
public Visibility WindowIconVisibility { get; set; }
The window icon visibility.
WindowTitleStyle
Style
Gets or sets the WindowTitle style.
public Style WindowTitleStyle { get; set; }
The WindowTitleStyle.
Methods
ContainerFromContextualGroupItem(object)
DependencyObject
Returns the container for the given item.
public DependencyObject ContainerFromContextualGroupItem(object item)
The item for which the container should be returned.
Returns:DependencyObject
The container or null if the container hasn't been generated.
Returns a new instance of the control that implements the IRadTabItem interface.
GetContainerForItemOverride()
DependencyObject
Creates or identifies the element used to display a specified item.
protected override DependencyObject GetContainerForItemOverride()
DependencyObject
Overrides:
Returns the item for a specific container.
public object ItemFromContextualGroupContainer(DependencyObject container)
The container.
Returns:Called when the control is measure.
protected override Size MeasureOverride(Size availableSize)
Size
Raises the event.
protected virtual void OnApplicationMenuOpenStateChanged(RadRoutedEventArgs e)
The RadRoutedEventArgs instance containing the event data.
When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate().
public override void OnApplyTemplate()
Raises the event.
protected virtual void OnCollapsedChanged(RadRoutedEventArgs e)
The RadRoutedEventArgs instance containing the event data.
OnCreateAutomationPeer()
AutomationPeer
Creates a peer associated with this object.
protected override AutomationPeer OnCreateAutomationPeer()
AutomationPeer
An instance of the .
Raises the event.
protected virtual void OnHelpRequested(RadRoutedEventArgs e)
The RadRoutedEventArgs instance containing the event data.
Raises the event. This method is invoked whenever is set to true internally.
protected override void OnInitialized(EventArgs e)
The RoutedEventArgs that contains the event data.
Called when the value of the property changes.
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
A NotifyCollectionChangedEventArgs that contains the event data.
Called when any Key have been pressed.
protected override void OnKeyUp(KeyEventArgs e)
Raises the event.
protected virtual void OnLayoutModeChanged(RadRoutedEventArgs e)
The RadRoutedEventArgs instance containing the event data.
Raises the event.
protected virtual void OnMinimizedChanged(RadRoutedEventArgs e)
The RadRoutedEventArgs instance containing the event data.
Raises the event.
protected virtual void OnMinimizedPopupStateChanged(RadRoutedEventArgs e)
The RadRoutedEventArgs instance containing the event data.
Called when the Selected item has changed.
protected override void OnSelectionChanged(RadSelectionChangedEventArgs e)
Overrides:
Raises the event.
protected virtual void OnToolBarPositionChanged(RadRoutedEventArgs e)
The RadRoutedEventArgs instance containing the event data.
Prepares the specified element to display the specified item.
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Element used to display the specified item.
itemobjectSpecified item.
Resets the theme.
public void ResetTheme()
Events
Occurs when user double click on the application button.
public event EventHandler<RadRoutedEventArgs> ApplicationButtonDoubleClick
Occurs when the application menu changes its open state.
public event EventHandler<RadRoutedEventArgs> ApplicationMenuOpenStateChanged
Occurs when ribbon bar collapsed state has changed.
public event EventHandler<RadRoutedEventArgs> CollapsedChanged
Occurs when user click on the help button.
public event EventHandler<RadRoutedEventArgs> HelpRequested
Occurs when ribbon view layout mode has changed.
public event EventHandler<RadRoutedEventArgs> LayoutModeChanged
Occurs when ribbon bar minimized state has changed.
public event EventHandler<RadRoutedEventArgs> MinimizedChanged
Occurs when ribbon bar minimized popup open state has changed.
public event EventHandler<RadRoutedEventArgs> MinimizedPopupOpenStateChanged
PopupOpened
RoutedEventHandler
Occurs when the Popup is opened.
public event RoutedEventHandler PopupOpened
Occurs before ribbon bar minimized state has changed.
public event EventHandler<RadRoutedEventArgs> PreviewMinimizedChanged
Occurs when the Popup is opening.
public event RadRoutedEventHandler PreviewPopupOpened
Occurs when location of the toolbar has changed.
public event EventHandler<RadRoutedEventArgs> ToolBarPositionChanged