Class BackstageView

Represents a control that provides a separate vertical tab view and is used in a see cref="RibbonBackstage"/>

Inheritance

System.Object

BackstageView

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.Ribbon

Assembly: Syncfusion.Ribbon.WinUI.dll

Syntax

public sealed class BackstageView : Control, IDisposable

Remarks

The BackstageView allows to add BackstageViewTabItem and BackstageViewButtonItem as items and these items can be separated using BackstageViewItemSeparator.

Examples

The code example below shows how to populate BackstageView control with Items and FooterItems.

 <syncfusion:RibbonBackstage Target="{Binding ElementName=rootGrid}">
      <syncfusion:BackstageView ShowBackButton="True" >
          < syncfusion:BackstageView.Items>
              <syncfusion:BackstageViewTabItem Header="New"
                                               Icon="NewFolder">
                  <local:Sample1 />
              </syncfusion:BackstageViewTabItem>
              <syncfusion:BackstageViewTabItem Header="Open" >
                  < syncfusion:BackstageViewTabItem.Icon>
                      <FontIcon Glyph="&#xED25;" />
                  </ syncfusion:BackstageViewTabItem.Icon>
                  <local:Sample2 />
              </syncfusion:BackstageViewTabItem>
              <syncfusion:BackstageViewItemSeparator />
              <syncfusion:BackstageViewTabItem Header="Info" >
                  < local:Sample1 />
              </syncfusion:BackstageViewTabItem>
              <syncfusion:BackstageViewButtonItem Command="{x:Bind SaveCommand}"
                                                  Header="Save">
                  <syncfusion:BackstageViewButtonItem.Icon>
                      <FontIcon Glyph="&#xED25;" />
                  </ syncfusion:BackstageViewButtonItem.Icon>
              </syncfusion:BackstageViewButtonItem>
              <syncfusion:BackstageViewButtonItem Command="{x:Bind CloseButtonCommand}"
                                                  Header="Close" />
      </syncfusion:BackstageView.Items>
         <syncfusion:BackstageView.FooterItems>
             <syncfusion:BackstageViewItemSeparator />
             <syncfusion:BackstageViewTabItem Header="Account" >
                 < local:Sample2 />
             </syncfusion:BackstageViewTabItem>
             <syncfusion:BackstageViewTabItem Header="FeedBack" >
                 < local:Sample1 />
             </syncfusion:BackstageViewTabItem>
             <syncfusion:BackstageViewButtonItem Command="{x:Bind OptionCommand}"
                                                 Header="Option" />
         </syncfusion:BackstageView.FooterItems>
     </syncfusion:BackstageView>
 </syncfusion:RibbonBackstage>

Constructors

BackstageView()

Initializes a new instance of the BackstageView class.

Declaration

public BackstageView()

Fields

FooterItemsProperty

Identifies the FooterItems dependency property.

Declaration

public static readonly DependencyProperty FooterItemsProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

ItemsProperty

Identifies the Items dependency property.

Declaration

public static readonly DependencyProperty ItemsProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

SelectedItemProperty

Identifies the SelectedItem dependency property.

Declaration

public static readonly DependencyProperty SelectedItemProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

ShowBackButtonProperty

Identifies the ShowBackButton dependency property.

Declaration

public static readonly DependencyProperty ShowBackButtonProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

TitleProperty

Identifies the Title dependency property.

Declaration

public static readonly DependencyProperty TitleProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Properties

FooterItems

Gets the collection used to generate the footer items of the BackstageView control.

Declaration

public IList<IBackstageViewItem> FooterItems { get; }

Property Value

Type	Description
System.Collections.Generic.IList<IBackstageViewItem>	The collection of items used to display in the footer of BackstageView control. The default value is null.

Items

Gets the collection used to generate the items of the BackstageView control.

Declaration

public IList<IBackstageViewItem> Items { get; }

Property Value

Type	Description
System.Collections.Generic.IList<IBackstageViewItem>	The collection of items used to display in the BackstageView control. The default value is null.

Remarks

The FooterItems can be used to arrange the items in the footer.

SelectedItem

Gets or sets the BackstageViewTabItem as selected item in BackstageView.

Declaration

public BackstageViewTabItem SelectedItem { get; set; }

Property Value

Type	Description
BackstageViewTabItem	The object that is the currently selected item or null if there is no currently selected item. The default value is null.

Remarks

This property is only applicable to BackstageViewTabItem and used to determine the currently selected BackstageViewTabItem by both user interaction and binding.

ShowBackButton

Gets or sets a value indicating whether the back button visibility is enabled in BackstageView.

Declaration

public bool ShowBackButton { get; set; }

Property Value

Type	Description
System.Boolean	true if back button is displayed; otherwise, false. The default value is true.

Remarks

When the back button is pressed, the value of IsBackstageOpen changes to false, and the backstage view will be closed.

Title

Gets or sets the text that displays as a title at the top of the BackstageView control.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	The text that displays the title of the BackstageView control. The default value is null.

Methods

Dispose()

Release the unmanaged resources of BackstageView.

Declaration

public void Dispose()

OnApplyTemplate()

Contains the template logic of BackstageView.

Declaration

protected override void OnApplyTemplate()

Events

SelectionChanged

Occurs when the currently selected item changes in BackstageView.

Declaration

public event SelectionChangedEventHandler SelectionChanged

Event Type

Type
Microsoft.UI.Xaml.Controls.SelectionChangedEventHandler

Remarks

This event occurs whenever a selection of BackstageViewTabItem is changed. A selection can be changed not only through user interaction, but also through binding and other set values.

Examples

This example demonstrates how to invoke the SelectionChanged event.

using Syncfusion.UI.Xaml.Ribbon;
BackstageView backstageView = new BackstageView();
backstageView.SelectionChanged += BackstageView_SelectionChanged;
private void BackstageView_SelectionChanged(object sender, SelectionChangedEventArgs e)
{
}

Implements

System.IDisposable