Application Tab
12 Jun 202314 minutes to read
The Application Tab is used to represent a Menu
that do some operations, such as File Menu to create, open, and print documents. Application Tab classified by Type
property with the following:
- Menu
- Backstage
Application Menu
The Application Menu is similar to traditional file Menu options and Syncfusion Menu
control is used internally to render this. To show Application Menu in Ribbon, set the Type
as Menu
and MenuSettings
to customize properties of ejMenu
.
Create Using Template
Set the UL element Id
to MenuItemID
property to create Application Menu and it will acts as template to render Menu.
<ul id="ribbonmenu">
<li>
<a>FILE</a>
<ul>
<li><a>New</a></li>
<li><a>Open</a></li>
<li><a>Save</a></li>
<li><a>Save as</a></li>
<li><a>Print</a></li>
</ul>
</li>
</ul>
<ej-ribbon id="defaultRibbon" width="500px">
<e-application-tab type=Menu menu-item-id="ribbonmenu">
<e-menu-settings open-on-click="true">
</e-menu-settings>
</e-application-tab>
<e-tabs>
<e-tab id="home" text="HOME">
<e-groups>
<e-group text="New" align-type=Rows content-id="Contents" type="custom">
<e-content>
<e-contents>
<e-content-groups>
<e-content-group id="new" text="New">
<e-button-settings image-position="ImageTop" content-type="ImageOnly" prefix-icon="e-icon e-ribbon e-print">
</e-button-settings>
</e-content-group>
</e-content-groups>
</e-contents>
</e-content>
</e-group>
</e-groups>
</e-tab>
</e-tabs>
</ej-ribbon>
Binding Data Source
Application Menu can be rendered using JSON Data Source. Please refer this
page to set data source to ejMenu
.
<ul id="ribbonmenu1"></ul>
<ej-ribbon id="defaultRibbon" width="500px">
<e-application-tab type=Menu menu-item-id="ribbonmenu1">
<e-menu-settings open-on-click="true">
</e-menu-settings>
</e-application-tab>
<e-tabs>
<e-tab id="home" text="HOME">
<e-groups>
<e-group text="Font">
<e-content>
<e-contents>
<e-content-groups>
<e-content-group id="bold" text="Bold" is-big="true">
<e-button-settings content-type="ImageOnly" prefix-icon="e-icon e-ribbon e-bold">
</e-button-settings>
</e-content-group>
</e-content-groups>
</e-contents>
</e-content>
</e-group>
</e-groups>
</e-tab>
</e-tabs>
</ej-ribbon>
<script type="text/javascript">
var data = [{
id: 1,
text: "File",
parentId: null
}, {
id: 11,
parentId: 1,
text: "Open"
}, {
id: 12,
parentId: 1,
text: "Save"
}, {
id: 121,
parentId: 12,
text: "Save As"
}, {
id: 122,
parentId: 12,
text: "Save All"
}];
$(function() {
$("#ribbonmenu1").ejMenu({
fields: {
dataSource: data,
id: "id",
parentId: "parentId",
text: "text"
}
})
});
</script>
Backstage Page
The Backstage page is where documents and related data of those can be managed, such as Create, Save and other information.
The Backstage page has a feature to add custom Control in left side of the page which contains menu items and the right side contains corresponding user controls.
You can set Application Tab Type
as Backstage
and set Id
, Text
to Backstage items. Backstage Pages
can be added with required ItemType
and ContentID
as template id to render template into Backstage.
Separator between Backstage items can be enabled by setting EnableSeparator
as true. Width of backstage side header can be customized using HeaderWidth
, If not set based on content given width will be considered.
To render the Ribbon with the Backstage page, refer to the following code snippet.
<ej-ribbon id="defaultRibbon" width="500px">
<e-application-tab type=Backstage text="FILE">
<e-backstage-settings text="FILE" height="360" width="600" headerWidth="125">
<e-pages>
<e-page-collection id="new" text="New" content-id="newCon"></e-page-collection>
<e-page-collection id="close" text="Close" enable-separator="true" item-type=Button></e-page-collection>
<e-page-collection id="account" text="Office Account" content-id="accountCon"></e-page-collection>
</e-pages>
</e-backstage-settings>
</e-application-tab>
<e-tabs>
<e-tab id="home" text="HOME">
<e-groups>
<e-group text="New" type="custom" content-id="ribbonContent">
</e-group>
</e-groups>
</e-tab>
</e-tabs>
</ej-ribbon>
<div id="newCon">
<table>
<tr>
<td>
<button id="btn1" class="e-bsnewbtnstyle">Blank WorkBook</button>
</td>
</tr>
</table>
</div>
<div id="accountCon">
<div class="e-userDiv">
<span>User Information</span>
<div>
<div class="e-accuser e-newpageicon"></div>
<div class="e-userCon">
<div>user</div>
<div>xy@syncfusion.com</div>
</div>
</div>
</div>
<a href="#">Sign out</a>
</div>
<div id="ribbonContent">Home control</div>
@section ScriptSection{
<script>
$("#btn1").ejButton({
size: "large",
height: 200,
width: 205,
contentType: "textandimage",
imagePosition: "imagetop",
prefixIcon: "e-icon e-blank e-infopageicon"
});
</script>
}
@section StyleSection{
<link href="@Url.Content("~/css/ejthemes/ribbon-css/ej.icons.css")" rel="stylesheet" />
<style>
.e-accuser {
background-image: url('../css/ejthemes/common-images/ribbon/user.jpg');
}
.e-blank {
background-image: url('../css/ejthemes/common-images/ribbon/blank.png');
}
.e-infopageicon {
background-repeat: no-repeat;
height: 150px;
width: 198px;
}
.e-newpageicon {
background-repeat: no-repeat;
height: 42px;
width: 42px;
}
.e-bspagestyle {
line-height: 0;
font-size: 30px;
}
.e-ribbon .e-ribbonbackstagepage .e-bsnewbtnstyle {
color: #212121;
background: #fdfdfd;
margin: 20px;
}
</style>
}
NOTE
Height & Width of backstage can be set using
Height
andWidth
, if these are not set, Ribbon’s Height & Width will be considered.
You can add/remove/update backStage item to the ribbon control by using addBackStageItem
, removeBackStageItem
and updateBackStageItem
methods. Also you can show/hide the backstage page in ribbon control by using showBackstage
and [hideBackstage
](https://help.syncfusion.com/api/js/ejribbon#methods:hidebackstage methods.