ClassRadRibbonBarBackstageView
Represents a BackstageView control that serves as the Office 2010 replacement for the ApplicationMenu. It can contain tabs, pages, buttons and all other RadItem elements as well.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadRibbonBarBackstageView : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadRibbonBarBackstageView
Implements:
Inherited Members
Constructors
RadRibbonBarBackstageView()
Declaration
public RadRibbonBarBackstageView()Fields
BackstageViewClosedEventKey
Event key for the BackstageViewClosed event.
Declaration
public static readonly object BackstageViewClosedEventKeyField Value
BackstageViewClosingEventKey
Event key for the BackstageViewClosing event.
Declaration
public static readonly object BackstageViewClosingEventKeyField Value
BackstageViewOpenedEventKey
Event key for the BackstageViewOpened event.
Declaration
public static readonly object BackstageViewOpenedEventKeyField Value
BackstageViewOpeningEventKey
Event key for the BackstageViewOpening event.
Declaration
public static readonly object BackstageViewOpeningEventKeyField Value
Properties
AdjustLocation
Gets or sets a value indicating whether the position of the RadRibbonBarBackstageView should be automatically adjusted to align with the bottom of the application button of the owner RadRibbonBar.
Declaration
[Browsable(false)]
public bool AdjustLocation { get; set; }Property Value
BackstageElement
Gets the BackstageViewElement that provides the main visual structure and functionality of the backstage view.
Declaration
[Browsable(false)]
public BackstageViewElement BackstageElement { get; }Property Value
IsShown
Gets a value indicating whether the backstage view is currently opened and displayed.
Items
Gets a collection of RadItem objects representing the items contained in this backstage view's items panel.
Declaration
[RadEditItemsAction]
public RadItemOwnerCollection Items { get; }Property Value
Owner
Gets the RadRibbonBarElement that owns and hosts this backstage view.
Declaration
[Browsable(false)]
public RadRibbonBarElement Owner { get; }Property Value
SelectedItem
Gets or sets the currently selected BackstageTabItem in the backstage view.
Declaration
[Browsable(false)]
public BackstageTabItem SelectedItem { get; set; }Property Value
Visible
Gets or sets a value indicating whether the RadRibbonBarBackstageView control is visible. This property is typically managed automatically when showing or hiding the backstage view.
Declaration
[Browsable(false)]
public bool Visible { get; set; }Property Value
Methods
ControlDefinesThemeForElement(RadElement)
Determines whether the control defines a theme for the specified element.
Declaration
public override bool ControlDefinesThemeForElement(RadElement element)Parameters
element
The element to check.
Returns
true if the control defines a theme for the element; otherwise, false.
Overrides
CreateBehavior()
Creates and returns the input behavior for handling user interaction with the backstage view.
Declaration
protected override ComponentInputBehavior CreateBehavior()Returns
A RadRibbonBarBackstageView.RibbonBackstageViewInputBehavior instance that handles keyboard and mouse input.
Overrides
CreateChildItems(RadElement)
Creates the child items for the backstage view, including the main BackstageViewElement.
Declaration
protected override void CreateChildItems(RadElement parent)Parameters
parent
The parent element to which the child items will be added.
Overrides
Dispose(bool)
Releases the unmanaged resources used by the RadRibbonBarBackstageView and optionally releases the managed resources.
Declaration
protected override void Dispose(bool disposing)Parameters
disposing
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides
HidePopup()
Hides the backstage view and restores the ribbon bar to its normal state.
Declaration
public void HidePopup()IsInputKey(Keys)
Determines whether the specified key is an input key that should be processed by the control.
OnBackstageViewClosed()
Raises the BackstageViewClosed event and updates the owner ribbon bar state.
Declaration
protected virtual void OnBackstageViewClosed()OnBackstageViewClosing()
Raises the BackstageViewClosing event and determines if the closing operation should be cancelled.
Declaration
protected virtual bool OnBackstageViewClosing()Returns
true if the closing operation should be cancelled; otherwise, false.
OnBackstageViewOpened()
Raises the BackstageViewOpened event and initializes the backstage view state.
Declaration
protected virtual void OnBackstageViewOpened()OnBackstageViewOpening()
Raises the BackstageViewOpening event and determines if the opening operation should be cancelled.
Declaration
protected virtual bool OnBackstageViewOpening()Returns
true if the opening operation should be cancelled; otherwise, false.
OnKeyDown(KeyEventArgs)
Handles key down events, processes keyboard navigation and key tips, and closes the backstage view on Escape key.
Declaration
protected override void OnKeyDown(KeyEventArgs e)Parameters
e
The key event arguments.
Overrides
OnKeyTipItemActivating(RadItem, CancelEventArgs)
Handles the key tip item activation event and raises the KeyTipActivating event.
Declaration
protected bool OnKeyTipItemActivating(RadItem item, CancelEventArgs eventArgs)Parameters
item
The RadItem for which the key tip is being activated.
eventArgs
The event arguments containing cancellation information.
Returns
true if the activation should be cancelled; otherwise, false.
OnKeyTipShowing(RadItem, CancelEventArgs)
Handles the key tip showing event and raises the KeyTipShowing event.
Declaration
protected virtual bool OnKeyTipShowing(RadItem currentKeyMapItem, CancelEventArgs eventArgs)Parameters
currentKeyMapItem
The RadItem for which the key tip is being shown.
eventArgs
The event arguments containing cancellation information.
Returns
true if the key tip display should be cancelled; otherwise, false.
OnPaint(PaintEventArgs)
Handles the paint event and renders key tips when the key map is active.
Declaration
protected override void OnPaint(PaintEventArgs e)Parameters
e
The paint event arguments.
Overrides
OnParentChanged(EventArgs)
Handles the parent changed event and manages the associated form's style change events.
Declaration
protected override void OnParentChanged(EventArgs e)Parameters
e
The event arguments.
Overrides
OnVisibleChanged(EventArgs)
Handles the visible changed event and hides the popup if the control becomes invisible while shown.
Declaration
protected override void OnVisibleChanged(EventArgs e)Parameters
e
The event arguments.
Overrides
PaintKeyMap(Graphics)
Renders the key map visual indicators on the specified graphics surface.
Declaration
protected virtual void PaintKeyMap(Graphics graphics)Parameters
graphics
The graphics surface to paint on.
PaintKeyTip(Graphics, RadKeyTipShowingEventArgs, string)
Renders an individual key tip at the specified location with the given appearance settings.
Declaration
protected virtual void PaintKeyTip(Graphics graphics, RadKeyTipShowingEventArgs args, string keyTip)Parameters
graphics
The graphics surface to paint on.
args
The key tip showing event arguments containing appearance information.
keyTip
The text to display in the key tip.
ProcessCmdKey(ref Message, Keys)
Processes command keys for keyboard navigation within the backstage view.
ShowPopup(Point, RadRibbonBarElement)
Displays the backstage view as a popup at the specified location with the given owner.
Declaration
public void ShowPopup(Point location, RadRibbonBarElement owner)Parameters
location
The screen coordinates where the backstage view should be displayed.
owner
The RadRibbonBarElement that owns this backstage view.
ShowPopup(RadRibbonBarElement)
Displays the backstage view as a popup, automatically calculating the position relative to the owner ribbon bar.
Declaration
public void ShowPopup(RadRibbonBarElement owner)Parameters
owner
The RadRibbonBarElement that owns this backstage view.
UpdateControlButtonsStyle()
Updates the visibility and state of control buttons in the backstage view title bar based on the associated form properties.
Declaration
protected virtual void UpdateControlButtonsStyle()parentControl_SizeChanged(object, EventArgs)
Handles the parent control size change event and adjusts the backstage view size and position accordingly.
Events
BackstageViewClosed
Occurs when the backstage view has been closed and is no longer visible.
Declaration
public event EventHandler BackstageViewClosedEvent Value
BackstageViewClosing
Occurs when the backstage view is about to close, allowing the operation to be cancelled.
Declaration
public event CancelEventHandler BackstageViewClosingEvent Value
BackstageViewOpened
Occurs when the backstage view has been opened and is now visible.
Declaration
public event EventHandler BackstageViewOpenedEvent Value
BackstageViewOpening
Occurs when the backstage view is about to open, allowing the operation to be cancelled.
Declaration
public event CancelEventHandler BackstageViewOpeningEvent Value
ItemClicked
Occurs when an item from the backstage items panel is clicked.
Declaration
public event EventHandler<BackstageItemEventArgs> ItemClickedEvent Value
KeyTipActivating
Occurs when a key tip is about to be activated.
Declaration
public event CancelEventHandler KeyTipActivatingEvent Value
KeyTipShowing
Occurs when a key tip is about to be shown.
Declaration
public event CancelEventHandler KeyTipShowingEvent Value
SelectedItemChanged
Occurs when the selected tab has been changed.
Declaration
public event EventHandler<BackstageItemChangeEventArgs> SelectedItemChangedEvent Value
SelectedItemChanging
Occurs when the selected tab is about to change, allowing the operation to be cancelled.
Declaration
public event EventHandler<BackstageItemChangingEventArgs> SelectedItemChangingEvent Value