RibbonBackstage Class

[TemplatePart(Name = "PART_CloseButton", Type = typeof(RibbonBackstageCloseButton))]
[TemplatePart(Name = "PART_HeaderPanel", Type = typeof(Panel))]
[TemplatePart(Name = "PART_OverflowPresenter", Type = typeof(OverflowPresenter))]
[TemplatePart(Name = "PART_SelectedContentHost", Type = typeof(ContentPresenter))]
[TemplatePart(Name = "PART_TabSelectionElement", Type = typeof(FrameworkElement))]
public class RibbonBackstage : TabControl

public RibbonBackstage()

public bool CanClose { get; set; }

Property Value

bool:

true if the Backstage close button should be visible, and whether Esc can close Backstage; otherwise, false. The default value is true.

Remarks

This feature is useful for scenarios where there is no document open in the main window yet, and Backstage is open, allowing for an end user to select a new document or open a document. In this scenario, you don't want the end user to be able to close Backstage until they take some action.

public bool CanSelectFirstTabOnOpen { get; set; }

Property Value

bool:

true if the first tab should be selected when the Backstage is opened; otherwise, false. The default value is true.

public ICommand CloseCommand { get; }

Property Value

ICommand

public CornerRadius CornerRadius { get; set; }

Property Value

CornerRadius:

The corner radius of the control's border.

public Brush HeaderBackground { get; set; }

Property Value

Brush:

The Brush to use for the header's background.

public bool IsBackdropActive { get; }

Property Value

bool:

true if the system backdrop is being rendered in the background; otherwise, false.

public bool IsCloseButtonVisible { get; }

Property Value

bool:

true if the close button is visible; otherwise, false.

public bool IsOpen { get; set; }

Property Value

bool:

true if Backstage is open; otherwise, false.

public double MaxHeaderWidth { get; set; }

Property Value

double:

The maximum header width. The default value is 180.

public double MinHeaderWidth { get; set; }

Property Value

double:

The minimum header width. The default value is 140.

public double TitleBarHeight { get; }

Property Value

double:

The title bar height.

protected override Size ArrangeOverride(Size finalSize)

Parameter	Type	Description
finalSize	Size

Returns

Size:

The size of the control.

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The item container element.
item	object	The data item.

protected override DependencyObject GetContainerForItemOverride()

Returns

DependencyObject:

The element used to display the specified item.

[AttachedPropertyBrowsableForChildren]
public static RibbonBackstageHeaderAlignment GetHeaderAlignment(DependencyObject obj)

Parameter	Type	Description
obj	DependencyObject	The object from which the property value is read.

Returns

RibbonBackstageHeaderAlignment:

The object's value.

protected override bool IsItemItsOwnContainerOverride(object item)

Parameter	Type	Description
item	object	Specified item.

Returns

bool:

Returns true if the item is its own ItemContainer; otherwise, false.

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The type-specific AutomationPeer implementation.

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)

Parameter	Type	Description
e	DependencyPropertyChangedEventArgs	The event data.

protected virtual void OnIsOpenChanged(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	The RoutedEventArgs that contains the event data.

protected override void OnKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	Provides data for KeyEventArgs.

protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Parameter	Type	Description
e	MouseButtonEventArgs	The MouseButtonEventArgs that contains the event data. The event data reports that the left mouse button was pressed.

protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameter	Type	Description
e	MouseWheelEventArgs	The MouseWheelEventArgs that contains the event data.

protected override void OnSelectionChanged(SelectionChangedEventArgs e)

Parameter	Type	Description
e	SelectionChangedEventArgs	Provides data for SelectionChangedEventArgs.

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The element that is used to display the specified item.
item	object	The specified item to display.

public static void SetHeaderAlignment(DependencyObject obj, RibbonBackstageHeaderAlignment value)

Parameter	Type	Description
obj	DependencyObject	The object to which the attached property is written.
value	RibbonBackstageHeaderAlignment	The value to set.

public event RoutedEventHandler IsOpenChanged

Event Type

RoutedEventHandler

public static readonly DependencyProperty CanCloseProperty

public static readonly DependencyProperty CanSelectFirstTabOnOpenProperty

public static readonly DependencyProperty CornerRadiusProperty

public static readonly DependencyProperty HeaderAlignmentProperty

public static readonly DependencyProperty HeaderBackgroundProperty

public static readonly DependencyProperty IsBackdropActiveProperty

public static readonly DependencyProperty IsCloseButtonVisibleProperty

public static readonly RoutedEvent IsOpenChangedEvent

public static readonly DependencyProperty IsOpenProperty

public static readonly DependencyProperty MaxHeaderWidthProperty

public static readonly DependencyProperty MinHeaderWidthProperty

public static readonly DependencyProperty TitleBarHeightProperty