A page in the Backstage.
Parent Elements
This element can appear as a child of the following elements.
| Element | Description | Version Introduced | Pro Version Introduced |
|---|---|---|---|
| <Backstage> | The list of buttons and pages in the popup that appears when the user clicks the system button. | 1.0 | 3.2 |
Child Elements
The following elements can be children of this one.
| Element | Description | Appears | Version Introduced | Pro Version Introduced |
|---|---|---|---|---|
| <Command> | A single command that is associated to one or more buttons on the ribbon. | Exactly once | 1.0 | 3.2 |
Attributes
This element supports the following attributes:
| Attribute | Description | Version Introduced | Pro Version Introduced |
|---|---|---|---|
| Command | The command associated with this page's button | 1.0 | 3.2 |
| Key | The unique identifier of the page. (Required) | 1.0 | 3.2 |
Command
The Command attribute lets you associate an existing command with this page's button. Every page has a button automatically added to the left of the backstage, and associated it to a command is the only way to set it's icon, caption, etc. If you omit this attribute, then you need to include a child <Command> element within the page element.
Key
The Key attribute defines a unique identifier for the page. The identifier must be unique among pages but can share the same identifier as other elements such as commands or tags. The identifier is used to reference the page from properties and methods such as the EmbedWindow method.
Remarks
The Page element defines a backstage page. Including this element in the <Backstage> element is only the first step in creating a page. During your CREATE event, after the Init method has been called, you must call the EmbedWindow method to associate a running OI window with the page. Then the user clicks on this page, the assocated OI window is displayed on the right portion of the backstage.
Every page comes with a button on the left side of the backstage panel. In order to set that button's caption, icon, and other attributes, you must associate the page with a command. You can do this using either the Command attribute as explained above or by including a child <Command> element.
Example
<Page Key="INFO"> <Command Key="INFO" Caption="Info" KeyboardTip="I" SmallIcon="Images\16x16\info.png" Tooltip="The document's metadata." /> </Page> <Page Key="OPTIONS" Command="OPTIONS" />
