Class RadRibbonBarBackstageView

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.

Inheritance
System.Object
RadControl
RadRibbonBarBackstageView
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadRibbonBarBackstageView : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadRibbonBarBackstageView()

Declaration
public RadRibbonBarBackstageView()

Fields

BackstageViewClosedEventKey

Event key for the BackstageViewClosed event.

Declaration
public static readonly object BackstageViewClosedEventKey
Field Value
System.Object

BackstageViewClosingEventKey

Event key for the BackstageViewClosing event.

Declaration
public static readonly object BackstageViewClosingEventKey
Field Value
System.Object

BackstageViewOpenedEventKey

Event key for the BackstageViewOpened event.

Declaration
public static readonly object BackstageViewOpenedEventKey
Field Value
System.Object

BackstageViewOpeningEventKey

Event key for the BackstageViewOpening event.

Declaration
public static readonly object BackstageViewOpeningEventKey
Field Value
System.Object

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
public bool AdjustLocation { get; set; }
Property Value
System.Boolean

BackstageElement

Gets the BackstageViewElement that provides the main visual structure and functionality of the backstage view.

Declaration
public BackstageViewElement BackstageElement { get; }
Property Value
BackstageViewElement

IsShown

Gets a value indicating whether the backstage view is currently opened and displayed.

Declaration
public bool IsShown { get; }
Property Value
System.Boolean

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
RadItemOwnerCollection

Owner

Gets the RadRibbonBarElement that owns and hosts this backstage view.

Declaration
public RadRibbonBarElement Owner { get; }
Property Value
RadRibbonBarElement

SelectedItem

Gets or sets the currently selected BackstageTabItem in the backstage view.

Declaration
public BackstageTabItem SelectedItem { get; set; }
Property Value
BackstageTabItem

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
public bool Visible { get; set; }
Property Value
System.Boolean

Methods

ControlDefinesThemeForElement(RadElement)

Determines whether the control defines a theme for the specified element.

Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
RadElement element

The element to check.
Returns
System.Boolean

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
ComponentInputBehavior

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
RadElement parent

The parent element to which the child items will be added.
Overrides

Dispose(Boolean)

Releases the unmanaged resources used by the RadRibbonBarBackstageView and optionally releases the managed resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean 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.

Declaration
protected override bool IsInputKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

The key data to evaluate.
Returns
System.Boolean

true if the key is an input key; otherwise, false.
Overrides

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
System.Boolean

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
System.Boolean

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
System.Windows.Forms.KeyEventArgs 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
RadItem item

The RadItem for which the key tip is being activated.
System.ComponentModel.CancelEventArgs eventArgs

The event arguments containing cancellation information.
Returns
System.Boolean

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
RadItem currentKeyMapItem

The RadItem for which the key tip is being shown.
System.ComponentModel.CancelEventArgs eventArgs

The event arguments containing cancellation information.
Returns
System.Boolean

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
System.Windows.Forms.PaintEventArgs 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
System.EventArgs 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
System.EventArgs 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
System.Drawing.Graphics 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
System.Drawing.Graphics graphics

The graphics surface to paint on.
RadKeyTipShowingEventArgs args

The key tip showing event arguments containing appearance information.
System.String keyTip

The text to display in the key tip.

parentControl_SizeChanged(Object, EventArgs)

Handles the parent control size change event and adjusts the backstage view size and position accordingly.

Declaration
protected virtual void parentControl_SizeChanged(object sender, EventArgs e)
Parameters
System.Object sender

The source of the event.
System.EventArgs e

The event arguments.

ProcessCmdKey(ref Message, Keys)

Processes command keys for keyboard navigation within the backstage view.

Declaration
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
Parameters
System.Windows.Forms.Message msg

The Windows message to process.
System.Windows.Forms.Keys keyData

The key data associated with the message.
Returns
System.Boolean

true if the command key was processed; otherwise, false.

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
System.Drawing.Point location

The screen coordinates where the backstage view should be displayed.
RadRibbonBarElement 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
RadRibbonBarElement 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()

Events

BackstageViewClosed

Occurs when the backstage view has been closed and is no longer visible.

Declaration
public event EventHandler BackstageViewClosed
Event Type
System.EventHandler

BackstageViewClosing

Occurs when the backstage view is about to close, allowing the operation to be cancelled.

Declaration
public event CancelEventHandler BackstageViewClosing
Event Type
System.ComponentModel.CancelEventHandler

BackstageViewOpened

Occurs when the backstage view has been opened and is now visible.

Declaration
public event EventHandler BackstageViewOpened
Event Type
System.EventHandler

BackstageViewOpening

Occurs when the backstage view is about to open, allowing the operation to be cancelled.

Declaration
public event CancelEventHandler BackstageViewOpening
Event Type
System.ComponentModel.CancelEventHandler

ItemClicked

Occurs when an item from the backstage items panel is clicked.

Declaration
public event EventHandler<BackstageItemEventArgs> ItemClicked
Event Type
System.EventHandler<BackstageItemEventArgs>

KeyTipActivating

Occurs when a key tip is about to be activated.

Declaration
public event CancelEventHandler KeyTipActivating
Event Type
System.ComponentModel.CancelEventHandler

KeyTipShowing

Occurs when a key tip is about to be shown.

Declaration
public event CancelEventHandler KeyTipShowing
Event Type
System.ComponentModel.CancelEventHandler

SelectedItemChanged

Occurs when the selected tab has been changed.

Declaration
public event EventHandler<BackstageItemChangeEventArgs> SelectedItemChanged
Event Type
System.EventHandler<BackstageItemChangeEventArgs>

SelectedItemChanging

Occurs when the selected tab is about to change, allowing the operation to be cancelled.

Declaration
public event EventHandler<BackstageItemChangingEventArgs> SelectedItemChanging
Event Type
System.EventHandler<BackstageItemChangingEventArgs>

Extension Methods