Class RadRibbonBarBackstageView

Represents a BackstageView control - the Office 2010 replacement of ApplicationMenu.

It can contain tabs, pages, buttons and all other RadItems 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

Declaration
public static readonly object BackstageViewClosedEventKey
Field Value
System.Object

BackstageViewClosingEventKey

Declaration
public static readonly object BackstageViewClosingEventKey
Field Value
System.Object

BackstageViewOpenedEventKey

Declaration
public static readonly object BackstageViewOpenedEventKey
Field Value
System.Object

BackstageViewOpeningEventKey

Declaration
public static readonly object BackstageViewOpeningEventKey
Field Value
System.Object

Properties

AdjustLocation

Gets or sets a value that indicates whether the position of the BackstageView should be automatically adjusted to the bottom of the application button of the owner RadRibbonBar.

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

BackstageElement

Gets the backstage element.

Declaration
public BackstageViewElement BackstageElement { get; }
Property Value
BackstageViewElement

IsShown

Indicates whether the backstage view is opened.

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

Items

Declaration
[RadEditItemsAction]
public RadItemOwnerCollection Items { get; }
Property Value
RadItemOwnerCollection

Owner

Gets the RadRibbonBar element that the backstage view is attached to.

Declaration
public RadRibbonBarElement Owner { get; }
Property Value
RadRibbonBarElement

SelectedItem

Gets or sets the selected tab.

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

Visible

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

Methods

ControlDefinesThemeForElement(RadElement)

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

Returns
System.Boolean

Overrides

CreateBehavior()

Declaration
protected override ComponentInputBehavior CreateBehavior()
Returns
ComponentInputBehavior

Overrides

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

Overrides

HidePopup()

Hides the backstage view.

Declaration
public void HidePopup()

IsInputKey(Keys)

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

Returns
System.Boolean

Overrides

OnBackstageViewClosed()

Raises the BackstageViewClosed event.

Declaration
protected virtual void OnBackstageViewClosed()

OnBackstageViewClosing()

Raises the BackstageViewClosing event.

Declaration
protected virtual bool OnBackstageViewClosing()
Returns
System.Boolean

OnBackstageViewOpened()

Raises the BackstageViewOpened event.

Declaration
protected virtual void OnBackstageViewOpened()

OnBackstageViewOpening()

Raises the BackstageViewOpening event.

Declaration
protected virtual bool OnBackstageViewOpening()
Returns
System.Boolean

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnKeyTipItemActivating(RadItem, CancelEventArgs)

Declaration
protected bool OnKeyTipItemActivating(RadItem item, CancelEventArgs eventArgs)
Parameters
RadItem item

System.ComponentModel.CancelEventArgs eventArgs

Returns
System.Boolean

OnKeyTipShowing(RadItem, CancelEventArgs)

Declaration
protected virtual bool OnKeyTipShowing(RadItem currentKeyMapItem, CancelEventArgs eventArgs)
Parameters
RadItem currentKeyMapItem

System.ComponentModel.CancelEventArgs eventArgs

Returns
System.Boolean

OnPaint(PaintEventArgs)

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
System.Windows.Forms.PaintEventArgs e

Overrides

OnParentChanged(EventArgs)

Declaration
protected override void OnParentChanged(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnVisibleChanged(EventArgs)

Declaration
protected override void OnVisibleChanged(EventArgs e)
Parameters
System.EventArgs e

Overrides

PaintKeyMap(Graphics)

Declaration
protected virtual void PaintKeyMap(Graphics graphics)
Parameters
System.Drawing.Graphics graphics

PaintKeyTip(Graphics, RadKeyTipShowingEventArgs, String)

Declaration
protected virtual void PaintKeyTip(Graphics graphics, RadKeyTipShowingEventArgs args, string keyTip)
Parameters
System.Drawing.Graphics graphics

RadKeyTipShowingEventArgs args

System.String keyTip

parentControl_SizeChanged(Object, EventArgs)

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

System.EventArgs e

ProcessCmdKey(ref Message, Keys)

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

System.Windows.Forms.Keys keyData

Returns
System.Boolean

ShowPopup(Point, RadRibbonBarElement)

Shows the backstage view mimicking popup.

Declaration
public void ShowPopup(Point location, RadRibbonBarElement owner)
Parameters
System.Drawing.Point location

The location on which the backstage will be shown.
RadRibbonBarElement owner

The RadRibbonBarElement that the backstage view is attached to.

ShowPopup(RadRibbonBarElement)

Shows the backstage view mimicking popup.

Declaration
public void ShowPopup(RadRibbonBarElement owner)
Parameters
RadRibbonBarElement owner

UpdateControlButtonsStyle()

Declaration
protected virtual void UpdateControlButtonsStyle()

Events

BackstageViewClosed

Fires when the backstage view is closed.

Declaration
public event EventHandler BackstageViewClosed
Event Type
System.EventHandler

BackstageViewClosing

Fires when the backstage view is about to close.

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

BackstageViewOpened

Fires when the backstage view is opened.

Declaration
public event EventHandler BackstageViewOpened
Event Type
System.EventHandler

BackstageViewOpening

Fires when the backstage view is about to open.

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

ItemClicked

Fires when an item from the items panel is clicked.

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

KeyTipActivating

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

KeyTipShowing

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

SelectedItemChanged

Fires when the selected tab is changed.

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

SelectedItemChanging

Fires when the selected tab is about to change.

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

Extension Methods