In This Article

RibbonBackstageViewModel Class

Represents a view model for a Backstage control within a ribbon.

public class RibbonBackstageViewModel : ObservableObjectBase, IHasTag
Inheritance:
object ObservableObjectBase object
Implements:
IHasTag

Constructors

RibbonBackstageViewModel()

Initializes an instance of the class.

public RibbonBackstageViewModel()

Properties

CanClose

Indicates whether the Backstage close button should be visible, and whether Esc can close Backstage.

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.

CanSelectFirstTabOnOpen

Indicates whether the first tab should be selected when the Backstage is opened.

public bool CanSelectFirstTabOnOpen { get; set; }

Property Value

bool:

The default value is true.

ContentTemplate

The Avalonia.Controls.Templates.IDataTemplate used to display Backstage tab content.

public IDataTemplate? ContentTemplate { get; set; }

Property Value

IDataTemplate

IsOpen

Indicates whether the Backstage is open.

public bool IsOpen { get; set; }

Property Value

bool:

The default value is false.

Items

The collection of items to display in the Backstage.

public ObservableCollection<object> Items { get; }

Property Value

ObservableCollection<object>

SelectedItem

The Backstage's selected item, which is a tab item in the Items collection.

public object? SelectedItem { get; set; }

Property Value

object

Tag

A user-defined object attached to the control.

public object? Tag { get; set; }

Property Value

object

Methods

Close()

Closes the Backstage.

public void Close()

Open()

Opens the Backstage.

public void Open()

ToString()

Returns the string representation of this object.

public override string ToString()

Returns

string:

The string representation of this object.

Inherited Members

Extension Methods