ArcGIS Pro 3.4 API Reference Guide
ArcGIS.Desktop.Framework.Contracts Namespace / BackstageTab Class
Members Example Version

BackstageTab Class
Represents a tab in the application backstage. This is an abstract class.
Syntax
Remarks

The Backstage is a full-screen user interface view that exposes additional functionality for the application and current project. The backstage consists of tabs and buttons. Each tab is scoped to a particular task and presents its own user interface. Buttons are simply commands that perform an operation and have no additional user interface in the backstage.

Backstage tabs are also contextual and will appear disabled in they specify a condition that has not been satisfied.

A custom BackstageTab has two components: a component class that derives from BackstageTab and a view class that derives from FrameworkElement, typically a UserControl. Backstage tabs must be defined in DAML.

DAML attributes
id Required identifier.
caption The tab label.
keytip The access key for the tab in keytip mode.
condition The DAML condition ID if the tab is contextual.
separator Show a separator before the item.
className Required class identifier. Optionally include namespace if not in default namespace.
assembly Assembly name if not in the default assembly.
publicKeyToken The necessary public key token if the assembly is strongly named.
version The version of the dll if the assembly is strongly named.

Example
<backstage>
   <insertTab id=acme_backstage_Options keytip="D" className="AcmeBackstageVM" caption="Options>
    <content className="AcmeBackstageTabOptionsView"/>
  </insertTab>
</backstage>
Inheritance Hierarchy

System.Object
   ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase
      ArcGIS.Desktop.Framework.Contracts.BackstageTab

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.
See Also