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