The root element for the SRP Ribbon Control.
Child Elements
The following elements can be children of this one.
| Element | Description | Appears | Version Introduced | Pro Version Introduced |
|---|---|---|---|---|
| <Backstage> | The list of buttons and pages in the popup that appears when the user clicks the system button. | Zero or once | 1.0 | 3.2 |
| <Commands> | Predefined list of commands that can be used by buttons anywhere on the ribbon. | Zero or once | 1.0 | 3.2 |
| <QuickAccessControls> | A list of controls that appear in the quick access toolbar. | Zero or once | 1.0 | 3.2 |
| <TabBarControls> | The list of controls that appear on the right end of the tab bar area. | Zero or once | 1.0 | 3.2 |
| <Tabs> | The list of all available tabs. | Zero or once | 1.0 | 3.2 |
Attributes
This element supports the following attributes:
| Attribute | Description | Version Introduced | Pro Version Introduced |
|---|---|---|---|
| AllowMinimize | Determines of the ribbon can be minimized by the user. | 1.0 | 3.2 |
| AnimationEnabled | Determines if the hot states of elements are change instantly or smoothly over a short period of time. | 1.0 | 3.2 |
| FrameThemeEnabled | Determines if the ribbon is merged into the parent window. | 1.0 | 3.2 |
| Minimized | Determines if the ribbon is minimized. | 1.0 | 3.2 |
| Name | The name of the control as it was defined in the Form Designer.(Required) | 1.0 | 3.2 |
| SystemButtonCaption | The system button's caption which is only visible when the system button is a tab. | 1.0 | 3.2 |
| SystemButtonIsTab | Determines if the ribbon application button is the first tab on the tab bar instead of a round button in the corner. | 1.0 | 3.2 |
| Theme | The theme used to render the ribbon. | 1.0 | 3.2 |
| Window | The name of this control's parent window. | 1.0 | 3.2 |
AllowMinimize
The AllowMinimize attribute is a boolean flag indicating whether or not the user can minimize the ribbon via the ribbon's built-in context menu. See AllowMinimize
AnimationEnabled
The AnimationEnabled attribute is a boolean flag indicating whether or not the ribbon employs subtle animation effects as the mouse moves over it. See AnimationEnabled
FrameThemeEnabled
The FrameThemeEnabled attribute is a boolean flag indicating whether or not the ribbon merges into the parent form rather than acting like any other child control. See FrameThemeEnabled
Minimized
The Minimized attribute is a boolean flag indicating whether or not the ribbon is minimized by default. See Minimized
Name
The Name attribute should contain the name of the control as it was defined in the Form Designer. If you change the name in the Form Designer, then you must change it here also.
SystemButtonCaption
The SystemButtonCaption attribute is the text that appears on the system tab, if it is enabled. See SystemButtonCaption
SystemButtonIsTab
The SystemButtonIsTab attribute is a boolean flag indicating whether or not the ribbon's system button appears as the first tab on the ribbon. See SystemButtonIsTab
Theme
The Theme attribute is the name of the default theme to use. See Theme.
Window
The Window attribute should contain the name of the window that is the parent of this control. This is an optional field that a framework might find useful in identifying which OI form is intended to use the XML.
Remarks
The Control element is the root element. It does not matter where you got the XML snippet so long as there is a root element called Control. The control element has two attributes that help identify the control's fully qualified name as recognized by OpenInsight.
Example
<Control Name="OLE_RIBBON" Window="NDW_RIBBON_TEST" FrameThemeEnabled="true" Theme="Office 2013"> <Commands> ... </Commands> <Tabs> ... </Tabs> <QuickAccessControls> ... </QuickAccessControls> <Backstage> ... </Backstage> <TabBarControls> ... </TabBarControls> </Control>
