Class Backstage

Represents the class for backstage of the control.

Inheritance

System.Object

Backstage

Implements

System.IDisposable

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

[SkinType(SkinVisualStyle = Skin.Office2013, Type = typeof(Backstage), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/Office2013Style.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Silver, Type = typeof(Backstage), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/Office2010SilverStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Black, Type = typeof(Backstage), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/Office2010BlackStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Blue, Type = typeof(Backstage), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/Office2010BlueStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Transparent, Type = typeof(Backstage), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/TransparentStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Metro, Type = typeof(Backstage), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/Ribbon/Themes/MetroStyle.xaml")]
public class Backstage : Selector, IDisposable

Constructors

Backstage()

Initializes a new instance of the Backstage class.

Declaration

public Backstage()

Fields

AnimationDurationProperty

Identifies the AnimationDuration dependency property.

Declaration

public static readonly DependencyProperty AnimationDurationProperty

Field Value

Type	Description
System.Windows.DependencyProperty

Remarks

The identifier for the AnimationDuration dependency property.

AnimationTypeProperty

Identifies the AnimationType dependency property.

Declaration

public static readonly DependencyProperty AnimationTypeProperty

Field Value

Type	Description
System.Windows.DependencyProperty

Remarks

The identifier for the AnimationType dependency property.

PlacementTargetProperty

Identifies the PlacementTarget dependency property.

Declaration

public static readonly DependencyProperty PlacementTargetProperty

Field Value

Type	Description
System.Windows.DependencyProperty

Remarks

The identifier for the PlacementTarget dependency property.

PlacementTypeProperty

Identifies the PlacementType dependency property.

Declaration

public static readonly DependencyProperty PlacementTypeProperty

Field Value

Type	Description
System.Windows.DependencyProperty

Remarks

The identifier for the PlacementType dependency property.

SelectedTabContentProperty

Identifies the SelectedTabContent dependency property.

Declaration

public static readonly DependencyProperty SelectedTabContentProperty

Field Value

Type	Description
System.Windows.DependencyProperty

Remarks

The identifier for the SelectedTabContent dependency property.

SelectedTabItemForegroundProperty

Identifies the SelectedTabItemForeground dependency property.

Declaration

public static readonly DependencyProperty SelectedTabItemForegroundProperty

Field Value

Type	Description
System.Windows.DependencyProperty

Remarks

The identifier for the SelectedTabItemForeground dependency property.

TabHeaderTemplateProperty

Identifies the TabHeaderTemplate dependency property.

Declaration

public static readonly DependencyProperty TabHeaderTemplateProperty

Field Value

Type	Description
System.Windows.DependencyProperty

Remarks

The identifier for the TabHeaderTemplate dependency property.

Properties

AnimationDuration

Gets or sets the speed of the animation while expand or collapse the .

Declaration

public TimeSpan AnimationDuration { get; set; }

Property Value

Type	Description
System.TimeSpan	Type: System.TimeSpan Specifies the speed of a animation. The default value is 250 Milliseconds.

Examples

This example shows how to set AnimationDuration property in C#.

using System.Windows;
using Syncfusion.Windows.Tools.Controls;
namespace Sample1
{
    public partial class Window1 : Window
    {
        public Window1()
        {
            InitializeComponent();
            this.ribbonBackStage.AnimationDuration = TimeSpan.FromMilliseconds(250);
        }
    }
}

This example shows how to set AnimationDuration property in XAML.

<Window x:Class="Sample1.Window1"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:syncfusion="http://schemas.syncfusion.com/wpf"
Title="Window1" Height="300" Width="300">
<Grid>
<syncfusion:Ribbon Name="mainRibbon">
<syncfusion:Ribbon.BackStage>
<syncfusion:Backstage x:Name="ribbonBackStage" AnimationDuration="0:0:0.25" />
</syncfusion:Ribbon.BackStage>
</syncfusion:Ribbon>
</Grid>
</Window>

Declaration

public BackStageAnimationType AnimationType { get; set; }

Property Value

Type	Description
BackStageAnimationType	Type: BackStageAnimationType Specifies the type of a animation. The default value is Slide.

Examples

This example shows how to set AnimationType property in C#.

using System.Windows;
using Syncfusion.Windows.Tools.Controls;
namespace Sample1
{
    public partial class Window1 : Window
    {
        public Window1()
        {
            InitializeComponent();
            this.ribbonBackStage.AnimationType = Syncfusion.Windows.Tools.BackStageAnimationType.Fade;
        }
    }
}

This example shows how to set AnimationType property in XAML.

<Window x:Class="Sample1.Window1"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:syncfusion="http://schemas.syncfusion.com/wpf"
Title="Window1" Height="300" Width="300">
<Grid>
<syncfusion:Ribbon Name="mainRibbon">
<syncfusion:Ribbon.BackStage>
<syncfusion:Backstage x:Name="ribbonBackStage" AnimationType="Fade" />
</syncfusion:Ribbon.BackStage>
</syncfusion:Ribbon>
</Grid>
</Window>

PlacementTarget

Gets or sets the cref="UIElement"/> relative to which the should be positioned while it is opened.

Declaration

public UIElement PlacementTarget { get; set; }

Property Value

Type	Description
System.Windows.UIElement	The System.Windows.UIElement that is the logical parent of the Backstage. The default value is null.

Remarks

The Backstage will be occupies entire area of the PlacementTarget, when PlacementType is set to FullScreen.

Declaration

public BackStagePlacementType PlacementType { get; set; }

Property Value

Type	Description
BackStagePlacementType

SelectedTabContent

Gets or sets the content of the selected tab.

Declaration

public object SelectedTabContent { get; set; }

Property Value

Type	Description
System.Object	The content of the selected tab.

SelectedTabItemForeground

Gets or sets the foreground of selected tab item.

Declaration

public Brush SelectedTabItemForeground { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush

TabHeaderTemplate

Gets or sets the template of the Tab header.

Declaration

public DataTemplate TabHeaderTemplate { get; set; }

Property Value

Type	Description
System.Windows.DataTemplate

Methods

Dispose()

Declaration

public void Dispose()

GetContainerForItemOverride()

Creates or identifies the element that is used to display the given item.

Declaration

protected override DependencyObject GetContainerForItemOverride()

Returns

Type	Description
System.Windows.DependencyObject	The element that is used to display the given item.

IsItemItsOwnContainerOverride(Object)

Determines if the specified item is (or is eligible to be) its own container.

Declaration

protected override bool IsItemItsOwnContainerOverride(object item)

Parameters

Type	Name	Description
System.Object	item	The item to check.

Returns

Type	Description
System.Boolean	true if the item is (or is eligible to be) its own container; otherwise, false.

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

Declaration

public override void OnApplyTemplate()

OnCreateAutomationPeer()

Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Type	Description
System.Windows.Automation.Peers.AutomationPeer	The type-specific AutomationPeer implementation.

OnInitialized(EventArgs)

Raises the Initialized event.

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs instance containing the event data.

OnItemsChanged(NotifyCollectionChangedEventArgs)

Updates the current selection when an item in the System.Windows.Controls.Primitives.Selector has changed

Declaration

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

Type	Name	Description
System.Collections.Specialized.NotifyCollectionChangedEventArgs	e	The event data.

OnMouseLeftButtonDown(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.MouseLeftButtonDown routed event is raised on this element. Implement this method to add class handling for this event.

Declaration

protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e	The System.Windows.Input.MouseButtonEventArgs that contains the event data. The event data reports that the left mouse button was pressed.

OnSelectionChanged(SelectionChangedEventArgs)

Called when the selection changes.

Declaration

protected override void OnSelectionChanged(SelectionChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.Controls.SelectionChangedEventArgs	e	The event data.

OnStylusSystemGesture(StylusSystemGestureEventArgs)

Invoked when an unhandled Stylus. StylusSystemGesture attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration

protected override void OnStylusSystemGesture(StylusSystemGestureEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.StylusSystemGestureEventArgs	e	The event data

OnTouchDown(TouchEventArgs)

Provides class handling for the TouchDown routed event that occurs when a touch presses inside this element.

Declaration

protected override void OnTouchDown(TouchEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.TouchEventArgs	e	The event data

Implements

System.IDisposable

WPF- v20.4.0.38

Class Backstage

Inheritance

Implements

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

Constructors

Backstage()

Declaration

Fields

AnimationDurationProperty

Declaration

Field Value

Remarks

AnimationTypeProperty

Declaration

Field Value

Remarks

PlacementTargetProperty

Declaration

Field Value

Remarks

PlacementTypeProperty

Declaration

Field Value

Remarks

SelectedTabContentProperty

Declaration

Field Value

Remarks

SelectedTabItemForegroundProperty

Declaration

Field Value

Remarks

TabHeaderTemplateProperty

Declaration

Field Value

Remarks

Properties

AnimationDuration

Declaration

Property Value

Examples

See Also

AnimationType

Declaration

Property Value

Examples

See Also

PlacementTarget

Declaration

Property Value

Remarks

See Also

PlacementType

Declaration

Property Value

SelectedTabContent

Declaration

Property Value

SelectedTabItemForeground

Declaration

Property Value

TabHeaderTemplate

Declaration

Property Value

Methods

Dispose()

Declaration

GetContainerForItemOverride()

Declaration

Returns

IsItemItsOwnContainerOverride(Object)

Declaration

Parameters

Returns

OnApplyTemplate()

Declaration

OnCreateAutomationPeer()