It helps to organize a spreadsheet’s features into a series of tabs. By clicking the expand or collapse icon, you can expand or collapse the ribbon toolbar dynamically.
You can customize the ribbon using the following methods,
Method | Action |
---|---|
hideRibbonTabs |
Used to show or hide the existing ribbon tabs. |
enableRibbonTabs |
Used to enable or disable the existing ribbon tabs. |
addRibbonTabs |
Used to add custom ribbon tabs. |
hideToolbarItems |
Used to show or hide the existing ribbon toolbar items. |
enableToolbarItems |
Used to enable or disable the specified toolbar items. |
addToolbarItems |
Used to add the custom items in ribbon toolbar. |
hideFileMenuItems |
Used to show or hide the ribbon file menu items. |
enableFileMenuItems |
Used to enable or disable file menu items. |
addFileMenuItems |
Used to add custom file menu items. |
The following code example shows the usage of ribbon customization.
import { Component, ViewChild } from '@angular/core';
import { SpreadsheetComponent, MenuSelectEventArgs } from '@syncfusion/ej2-angular-spreadsheet';
import { select } from '@syncfusion/ej2-base';
import { ClickEventArgs } from '@syncfusion/ej2-navigations';
import { dataSource } from './datasource';
@Component({
selector: 'app-container',
template: `<ejs-spreadsheet #spreadsheet (created)="created()" (fileMenuBeforeOpen)="fileMenuBeforeOpen()"
(fileMenuItemSelect)="fileMenuItemSelect($event)" [openUrl]="openUrl" [saveUrl]="saveUrl" [showFormulaBar]="false" [showSheetTabs]="false" [allowInsert]="false" [allowDelete]="false" [allowMerge]="false">
<e-sheets>
<e-sheet>
<e-ranges>
<e-range [dataSource]="data"></e-range>
</e-ranges>
<e-columns>
<e-column [width]=180></e-column>
<e-column [width]=130></e-column>
<e-column [width]=130></e-column>
<e-column [width]=180></e-column>
<e-column [width]=130></e-column>
<e-column [width]=120></e-column>
</e-columns>
</e-sheet>
</e-sheets>
</ejs-spreadsheet>`
})
export class AppComponent {
@ViewChild('spreadsheet')
spreadsheetObj: SpreadsheetComponent;
data: object[] = dataSource;
openUrl = 'https://ej2services.syncfusion.com/production/web-services/api/spreadsheet/open';
saveUrl = 'https://ej2services.syncfusion.com/production/web-services/api/spreadsheet/save';
created() {
this.spreadsheetObj.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'A1:F1');
// Hiding the `Insert` from ribbon.
this.spreadsheetObj.hideRibbonTabs(['Insert']);
// Set disabled state to `View` ribbon tab.
this.spreadsheetObj.enableRibbonTabs(['View'], false);
/// Adding the `Help` ribbon tab at the last index.
// Specify the ribbon tab header text in last optional argument(`insertBefore`) for inserting new tab before any existing tab.
this.spreadsheetObj.addRibbonTabs([{ header: { text: 'Help' }, content: [{ text: 'Feedback', tooltipText: 'Feedback',
click: (args: ClickEventArgs): void => { /* Any click action for this toolbar item will come here. */ } }] }]);
// Hiding the unwanted toobar items from `Home` by specifying its index.
this.spreadsheetObj.hideToolbarItems('Home', [0, 1, 2, 4, 14, 15, 21, 24]);
// Set diable state to `Underline`, 'Wrap text` toobar items from `Home` by specifying the item id.
this.spreadsheetObj.enableToolbarItems(
'Home', [`${this.spreadsheetObj.element.id}_underline`, `${this.spreadsheetObj.element.id}_wrap`], false);
// Set disable state to `Protect Sheet` toolbar item from `Data` by mentioning its index.
this.spreadsheetObj.enableToolbarItems('Data', [0], false);
// Adding the new `Custom Formulas` toolbar item under `Formulas` tab for adding custom formulas.
this.spreadsheetObj.addToolbarItems(
'Formulas', [{ type: 'Separator' }, {
text: 'Custom Formulas', tooltipText: 'Custom Formulas',
// You can set click handler for each new custom toolbar item
click: (args: ClickEventArgs): void => {
// You can add custom formualas here.
}
}]);
// Adding new custom item `Import` after the existing `Open` item. By default, new item will add after the specified item.
this.spreadsheetObj.addFileMenuItems([{ text: 'Import', iconCss: 'e-open e-icons' }], 'Open');
// Adding new custom item `Export As` after the existing `Save As` item.
// Set `insertAfter` optional argument as `false` for adding new item before the specified item.
this.spreadsheetObj.addFileMenuItems(
[{
text: 'Export As', iconCss: 'e-save e-icons', items: [{ text: 'XLSX', iconCss: 'e-xlsx e-icons' },
{ text: 'XLS', iconCss: 'e-xls e-icons' }, { text: 'CSV', iconCss: 'e-csv e-icons' }]
}],
'Save As', false);
}
fileMenuBeforeOpen (): void {
// Because the file menu items are created dynamically, you need to perform the hide or show and enable/disable operations
// under filemenu before open event.
// Hiding the `Save As` and `Open` item.
this.spreadsheetObj.hideFileMenuItems(['Save As', 'Open']);
// Set disable state to `New` item. You can perform any file menu items customization by specifying the item id,
// if it has more than one same item text. Set the last argument `isUniqueId` as true for using the item id.
this.spreadsheetObj.enableFileMenuItems([`${this.spreadsheetObj.element.id}_New`], false, true);
}
fileMenuItemSelect (args: MenuSelectEventArgs): void {
// Custom file menu items select handler
switch (args.item.text) {
case 'Import': select(`#${this.spreadsheetObj.element.id}_fileUpload`, this.spreadsheetObj.element).click();
break;
case 'XLSX': this.spreadsheetObj.save({ saveType: 'Xlsx' });
break;
case 'XLS': this.spreadsheetObj.save({ saveType: 'Xls' });
break;
case 'CSV': this.spreadsheetObj.save({ saveType: 'Csv' });
break;
}
}
}
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { SpreadsheetAllModule } from '@syncfusion/ej2-angular-spreadsheet';
import { AppComponent } from './app.component';
/**
* Module
*/
@NgModule({
imports: [
BrowserModule,
SpreadsheetAllModule
],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule { }
/**
* Ribbon customization data source
*/
export let dataSource: Object[] = [
{
'Customer Name': 'Romona Heaslip',
'Model': 'Taurus',
'Color': 'Aquamarine',
'Payment Mode': 'Debit Card',
'Delivery Date': '07/11/2015',
'Amount': '8529.22'
},
{
'Customer Name': 'Clare Batterton',
'Model': 'Sparrow',
'Color': 'Pink',
'Payment Mode': 'Cash On Delivery',
'Delivery Date': '7/13/2016',
'Amount': '17866.19'
},
{
'Customer Name': 'Eamon Traise',
'Model': 'Grand Cherokee',
'Color': 'Blue',
'Payment Mode': 'Net Banking',
'Delivery Date': '09/04/2015',
'Amount': '13853.09'
},
{
'Customer Name': 'Julius Gorner',
'Model': 'GTO',
'Color': 'Aquamarine',
'Payment Mode': 'Credit Card',
'Delivery Date': '12/15/2017',
'Amount': '2338.74'
},
{
'Customer Name': 'Jenna Schoolfield',
'Model': 'LX',
'Color': 'Yellow',
'Payment Mode': 'Credit Card',
'Delivery Date': '10/08/2014',
'Amount': '9578.45'
},
{
'Customer Name': 'Marylynne Harring',
'Model': 'Catera',
'Color': 'Green',
'Payment Mode': 'Cash On Delivery',
'Delivery Date': '7/01/2017',
'Amount': '19141.62'
},
{
'Customer Name': 'Vilhelmina Leipelt',
'Model': '7 Series',
'Color': 'Goldenrod',
'Payment Mode': 'Credit Card',
'Delivery Date': '12/20/2015',
'Amount': '6543.30'
},
{
'Customer Name': 'Barby Heisler',
'Model': 'Corvette',
'Color': 'Red',
'Payment Mode': 'Credit Card',
'Delivery Date': '11/24/2014',
'Amount': '13035.06'
},
{
'Customer Name': 'Karyn Boik',
'Model': 'Regal',
'Color': 'Indigo',
'Payment Mode': 'Debit Card',
'Delivery Date': '05/12/2014',
'Amount': '18488.80'
},
{
'Customer Name': 'Jeanette Pamplin',
'Model': 'S4',
'Color': 'Fuscia',
'Payment Mode': 'Net Banking',
'Delivery Date': '12/30/2014',
'Amount': '12317.04'
},
{
'Customer Name': 'Cristi Espinos',
'Model': 'TL',
'Color': 'Aquamarine',
'Payment Mode': 'Credit Card',
'Delivery Date': '12/18/2013',
'Amount': '6230.13'
}
];
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { enableProdMode } from '@angular/core';
import { AppModule } from './app.module';
enableProdMode();
platformBrowserDynamic().bootstrapModule(AppModule);