Angular

Search results

Protection in Angular Spreadsheet component

08 Apr 2021 / 6 minutes to read

Sheet protection helps you to prevent the users from modifying the data in the spreadsheet.

Protect Sheet

Protect sheet feature helps you to prevent the unknown users from accidentally changing, editing, moving, or deleting data in a spreadsheet. You can use the isProtected property to enable or disable the Protecting functionality.

The default value for isProtected property is false.

By default in protected sheet, selecting, formatting, inserting, deleting functionalities are disabled. To enable some of the above said functionalities the protectSettings options are used in a protected spreadsheet.

The available protectSettings options in spreadsheet are,

Options	Uses
`Select Cells`	Used to perform Cell Selection.
`Format Cells`	Used to perform Cell formatting.
`Format Rows`	Used to perform Row formatting.
`Format Columns`	Used to perform Column formatting.
`Insert Link`	Used to perform Hyperlink Insertions.

The default value for all protectSettings options are false.

By default, the Protect Sheet module is injected internally into the Spreadsheet to perform sheet protection function.

User Interface

In the active Spreadsheet, the sheet protection can be done by any of the following ways:

Select the Protect Sheet item in the Ribbon toolbar under the Data Tab, and then select your desired options.
Right-click the sheet tab, select the Protect Sheet item in the context menu, and then select your desired options.
Use the protectSheet() method programmatically.

The following code example shows Protect Sheet functionality in the Spreadsheet control.

Source

Preview

app.component.ts

app.module.ts

datasource.ts

main.ts

import { Component, ViewChild } from '@angular/core';
import { SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet';
import { enableRipple } from '@syncfusion/ej2-base';
import { dataSource1, dataSource2 } from './datasource';

enableRipple(true);

@Component({
selector: 'app-container',
template: `<ejs-spreadsheet #spreadsheet (created)="created()">
            <e-sheets>
              <e-sheet name="Budget" [isProtected]="true" [protectSettings]="{ selectCells: true }">
                <e-ranges>
                  <e-range [dataSource]="budgetData"></e-range>
                </e-ranges>
                <e-columns>
                  <e-column [width]=100></e-column>
                  <e-column [width]=100></e-column>
                  <e-column [width]=100></e-column>
                  <e-column [width]=100></e-column>
                </e-columns>
              </e-sheet>
              <e-sheet name="Salary">
                <e-ranges>
                  <e-range [dataSource]="salaryData"></e-range>
                </e-ranges>
                <e-columns>
                  <e-column [width]=100></e-column>
                  <e-column [width]=100></e-column>
                  <e-column [width]=100></e-column>
                  <e-column [width]=100></e-column>
                  </e-columns>
              </e-sheet>
            </e-sheets>
          </ejs-spreadsheet>`
})
export class AppComponent {
@ViewChild('spreadsheet')
spreadsheetObj: SpreadsheetComponent;

budgetData: object[] = dataSource1;

salaryData: object[] = dataSource2;

created() {
    this.spreadsheetObj.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'A1:D1');
    this.spreadsheetObj.cellFormat({ fontWeight: 'bold'}, 'A11:D11');
    this.spreadsheetObj.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'Salary!A1:D1');
}
}

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 { }

/**
 * Protect sheet data source
 */
export let dataSource1: Object[] = [
    {
      'Expense Type': 'Housing',
      'Projected Cost': 7000,
      'Actual Cost': 7500,
      'Difference': -500,
    },
    {
      'Expense Type': 'Transportation',
      'Projected Cost': 500,
      'Actual Cost': 500,
      'Difference': 0,
    },
    {
      'Expense Type': 'Insurance',
      'Projected Cost': 1000,
      'Actual Cost': 1000,
      'Difference': 0,
    },
    {
      'Expense Type': 'Food',
      'Projected Cost': 2000,
      'Actual Cost': 1800,
      'Difference': 200,
    },
    {
      'Expense Type': 'Pets',
      'Projected Cost': 300,
      'Actual Cost': 200,
      'Difference': 100,
    },
    {
      'Expense Type': 'Personel Care',
      'Projected Cost': 500,
      'Actual Cost': 500,
      'Difference': 0,
    },{
      'Expense Type': 'Loan',
      'Projected Cost': 1000,
      'Actual Cost': 1000,
      'Difference': 0,
    },{
      'Expense Type': 'Tax',
      'Projected Cost': 200,
      'Actual Cost': 200,
      'Difference': 0,
    },{
      'Expense Type': 'Savings',
      'Projected Cost': 1000,
      'Actual Cost': 900,
      'Difference': 100,
    },
    {
      'Expense Type': 'Total',
      'Projected Cost': 13500,
      'Actual Cost': 13600,
      'Difference': -100,
    }
  ];

  export let dataSource2: Object[] = [
    {
      'Earnings': 'Basic',
      'Credit Amount': 20000,
      'Deductions': 'Provident Fund',
      'Debit Amount': 2400,
    },
    {
      'Earnings': 'HRA',
      'Credit Amount': 8000,
      'Deductions': 'ESI',
      'Debit Amount': 0,
    },
    {
      'Earnings': 'Special Allowance',
      'Credit Amount': 25000,
      'Deductions': 'Professional Tax',
      'Debit Amount': 200,
    },
    {
      'Earnings': 'Incentives',
      'Credit Amount': 2000,
      'Deductions': 'TDS',
      'Debit Amount': 2750,
    },
    {
      'Earnings': 'Bonus',
      'Credit Amount': 1500,
      'Deductions': 'Other Deduction',
      'Debit Amount': 0,
    },
    {
      'Earnings': 'Total Earnings',
      'Credit Amount': 56500,
      'Deductions': 'Total Deductions',
      'Debit Amount': 5350,
    }
  ];

import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { enableProdMode } from '@angular/core';
import { AppModule } from './app.module';

enableProdMode();
platformBrowserDynamic().bootstrapModule(AppModule);

Unprotect Sheet

Unprotect sheet is used to enable all the functionalities that are already disabled in a protected spreadsheet.

User Interface

In the active Spreadsheet, the sheet Unprotection can be done by any of the following ways:

Select the Unprotect Sheet item in the Ribbon toolbar under the Data Tab.
Right-click the sheet tab, select the Unprotect Sheet item in the context menu.
Use the unprotectSheet() method programmatically.

Unlock the particular cells in the protected sheet

In protected spreadsheet, to make some particular cell or range of cells are editable, you can use lockCells() method, with the parameter range and isLocked property as false.

Source

Preview

app.component.ts

app.module.ts

datasource.ts

main.ts

import { Component, ViewChild } from '@angular/core';
import { SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet';
import { Dialog } from '@syncfusion/ej2-popups';
import { enableRipple } from '@syncfusion/ej2-base';
import { dataSource1, dataSource2 } from './datasource';

enableRipple(true);

@Component({
selector: 'app-container',
template: `<button class="e-btn" style="margin: 5px 0;" (click)="btnClick()">
            Unlock cells</button>
          <div id="dialog"></div>
          <ejs-spreadsheet #spreadsheet id="spreadsheet" (created)="created()">
            <e-sheets>
              <e-sheet name="Budget" [isProtected]="true" [protectSettings]="{ selectCells: true }">
                <e-ranges>
                  <e-range [dataSource]="budgetData"></e-range>
                </e-ranges>
                <e-columns>
                  <e-column [width]=100></e-column>
                  <e-column [width]=100></e-column>
                  <e-column [width]=100></e-column>
                  <e-column [width]=100></e-column>
                </e-columns>
              </e-sheet>
              <e-sheet name="Salary">
                <e-ranges>
                  <e-range [dataSource]="salaryData"></e-range>
                </e-ranges>
                <e-columns>
                  <e-column [width]=100></e-column>
                  <e-column [width]=100></e-column>
                  <e-column [width]=100></e-column>
                  <e-column [width]=100></e-column>
                  </e-columns>
              </e-sheet>
            </e-sheets>
          </ejs-spreadsheet>`
})
export class AppComponent {
@ViewChild('spreadsheet')
spreadsheetObj: SpreadsheetComponent;

dialogObj: Dialog;

budgetData: object[] = dataSource1;

salaryData: object[] = dataSource2;

created() {
    this.spreadsheetObj.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'A1:D1');
    this.spreadsheetObj.cellFormat({ fontWeight: 'bold'}, 'A11:D11');
    this.spreadsheetObj.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'Salary!A1:D1');

    // Creating dialog component,
    this.dialogObj = new Dialog({
        header: 'Spreadsheet',
        target: document.getElementById('spreadsheet'),
        content: '"A1:F3" range of cells has been unlocked.',
        showCloseIcon: true,
        isModel: true,
        visible: false,
        width: '500px',
        buttons: [{
            click: this.lockCells.bind(this), buttonModel: { content: 'Ok', isPrimary: true }
        }];
    });
    this.dialogObj.appendTo('#dialog');
}

btnClick (): void {
    this.dialogObj.show();
}

lockCells(): void {
    this.spreadsheetObj.lockCells('A1:F3', false);
    this.dialogObj.hide();
}
}

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 { }

/**
 * Protect sheet data source
 */
export let dataSource1: Object[] = [
    {
      'Expense Type': 'Housing',
      'Projected Cost': 7000,
      'Actual Cost': 7500,
      'Difference': -500,
    },
    {
      'Expense Type': 'Transportation',
      'Projected Cost': 500,
      'Actual Cost': 500,
      'Difference': 0,
    },
    {
      'Expense Type': 'Insurance',
      'Projected Cost': 1000,
      'Actual Cost': 1000,
      'Difference': 0,
    },
    {
      'Expense Type': 'Food',
      'Projected Cost': 2000,
      'Actual Cost': 1800,
      'Difference': 200,
    },
    {
      'Expense Type': 'Pets',
      'Projected Cost': 300,
      'Actual Cost': 200,
      'Difference': 100,
    },
    {
      'Expense Type': 'Personel Care',
      'Projected Cost': 500,
      'Actual Cost': 500,
      'Difference': 0,
    },{
      'Expense Type': 'Loan',
      'Projected Cost': 1000,
      'Actual Cost': 1000,
      'Difference': 0,
    },{
      'Expense Type': 'Tax',
      'Projected Cost': 200,
      'Actual Cost': 200,
      'Difference': 0,
    },{
      'Expense Type': 'Savings',
      'Projected Cost': 1000,
      'Actual Cost': 900,
      'Difference': 100,
    },
    {
      'Expense Type': 'Total',
      'Projected Cost': 13500,
      'Actual Cost': 13600,
      'Difference': -100,
    }
  ];

  export let dataSource2: Object[] = [
    {
      'Earnings': 'Basic',
      'Credit Amount': 20000,
      'Deductions': 'Provident Fund',
      'Debit Amount': 2400,
    },
    {
      'Earnings': 'HRA',
      'Credit Amount': 8000,
      'Deductions': 'ESI',
      'Debit Amount': 0,
    },
    {
      'Earnings': 'Special Allowance',
      'Credit Amount': 25000,
      'Deductions': 'Professional Tax',
      'Debit Amount': 200,
    },
    {
      'Earnings': 'Incentives',
      'Credit Amount': 2000,
      'Deductions': 'TDS',
      'Debit Amount': 2750,
    },
    {
      'Earnings': 'Bonus',
      'Credit Amount': 1500,
      'Deductions': 'Other Deduction',
      'Debit Amount': 0,
    },
    {
      'Earnings': 'Total Earnings',
      'Credit Amount': 56500,
      'Deductions': 'Total Deductions',
      'Debit Amount': 5350,
    }
  ];

import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { enableProdMode } from '@angular/core';
import { AppModule } from './app.module';

enableProdMode();
platformBrowserDynamic().bootstrapModule(AppModule);

Limitations of Protect Sheet

Password protection is not supported in Protect sheet feature.

Protect Workbook

Protect workbook feature helps you to protect the workbook so that users cannot insert, delete, rename, hide the sheets in the spreadsheet. You can use the password property to protect workbook with password. You can use the isProtected property to protect or unprotect the workbook without the password.

The default value for isProtected property is false.

User Interface

In the active Spreadsheet, you can protect the worksheet by selecting the Data tab in the Ribbon toolbar and choosing the Protect Workbook item. Then, enter the password and confirm it and click on OK.

The following code example shows Protect Workbook by using the isProtected property in the Spreadsheet control.

Source

Preview

app.component.ts

app.module.ts

datasource.ts

main.ts

import { Component, OnInit,ViewChild } from '@angular/core';
import { SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet';
import { data } from './datasource';

@Component({
selector: 'app-container',
template: "<ejs-spreadsheet #spreadsheet [isProtected]='true'> <e-sheets> <e-sheet> <e-ranges> <e-range [dataSource]='data'></e-range></e-ranges><e-columns><e-column [width]=90></e-column><e-column [width]=100></e-column><e-column [width]=96></e-column><e-column [width]=120></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 implements OnInit {
public data: object[];
@ViewChild('spreadsheet') public spreadsheetObj: SpreadsheetComponent;
ngOnInit(): void {
    this.data = data;
}
  };
}

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 { }

export let data: Object[] = [{
  OrderID: 10248,
  CustomerID: 'VINET',
  EmployeeID: 5,
  ShipName: 'Vins et alcools Chevalier',
  ShipCity: 'Reims',
  ShipAddress: '59 rue de lAbbaye'
},
{
  OrderID: 10249,
  CustomerID: 'TOMSP',
  EmployeeID: 6,
  ShipName: 'Toms Spezialitäten',
  ShipCity: 'Münster',
  ShipAddress: 'Luisenstr. 48'
},
{
  OrderID: 10250,
  CustomerID: 'HANAR',
  EmployeeID: 4,
  ShipName: 'Hanari Carnes',
  ShipCity: 'Rio de Janeiro',
  ShipAddress: 'Rua do Paço, 67'
},
{
  OrderID: 10251,
  CustomerID: 'VICTE',
  EmployeeID: 3,
  ShipName: 'Victuailles en stock',
  ShipCity: 'Lyon',
  ShipAddress: '2, rue du Commerce'
},
{
  OrderID: 10252,
  CustomerID: 'SUPRD',
  EmployeeID: 4,
  ShipName: 'Suprêmes délices',
  ShipCity: 'Charleroi',
  ShipAddress: 'Boulevard Tirou, 255'
}];

import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { enableProdMode } from '@angular/core';
import { AppModule } from './app.module';

enableProdMode();
platformBrowserDynamic().bootstrapModule(AppModule);

The following code example shows Protect Workbook by using the password property in the Spreadsheet control. To unprotect the workbook, click the unprotect workbook button in the data tab and provide the password as syncfusion in the dialog box.

Source

Preview

app.component.ts

app.module.ts

datasource.ts

main.ts

import { Component, OnInit,ViewChild } from '@angular/core';
import { SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet';
import { data } from './datasource';

@Component({
selector: 'app-container',
template: "<ejs-spreadsheet #spreadsheet [password]='syncfusion'> <e-sheets> <e-sheet> <e-ranges> <e-range [dataSource]='data'></e-range></e-ranges><e-columns><e-column [width]=90></e-column><e-column [width]=100></e-column><e-column [width]=96></e-column><e-column [width]=120></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 implements OnInit {
public data: object[];
@ViewChild('spreadsheet') public spreadsheetObj: SpreadsheetComponent;
ngOnInit(): void {
    this.data = data;
}
  };
}

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 { }

export let data: Object[] = [{
  OrderID: 10248,
  CustomerID: 'VINET',
  EmployeeID: 5,
  ShipName: 'Vins et alcools Chevalier',
  ShipCity: 'Reims',
  ShipAddress: '59 rue de lAbbaye'
},
{
  OrderID: 10249,
  CustomerID: 'TOMSP',
  EmployeeID: 6,
  ShipName: 'Toms Spezialitäten',
  ShipCity: 'Münster',
  ShipAddress: 'Luisenstr. 48'
},
{
  OrderID: 10250,
  CustomerID: 'HANAR',
  EmployeeID: 4,
  ShipName: 'Hanari Carnes',
  ShipCity: 'Rio de Janeiro',
  ShipAddress: 'Rua do Paço, 67'
},
{
  OrderID: 10251,
  CustomerID: 'VICTE',
  EmployeeID: 3,
  ShipName: 'Victuailles en stock',
  ShipCity: 'Lyon',
  ShipAddress: '2, rue du Commerce'
},
{
  OrderID: 10252,
  CustomerID: 'SUPRD',
  EmployeeID: 4,
  ShipName: 'Suprêmes délices',
  ShipCity: 'Charleroi',
  ShipAddress: 'Boulevard Tirou, 255'
}];

import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { enableProdMode } from '@angular/core';
import { AppModule } from './app.module';

enableProdMode();
platformBrowserDynamic().bootstrapModule(AppModule);

Unprotect Workbook

Unprotect Workbook is used to enable the insert, delete, rename, move, copy, hide or unhide sheets feature in the spreadsheet.

User Interface

In the active Spreadsheet, the workbook Unprotection can be done in any of the following ways:

Select the Unprotect Workbook item in the Ribbon toolbar under the Data Tab and provide the valid password in the dialog box.

Limitations of Protect Workbook

Encryption with password is not supported in the Protect workbook feature.

Protection in Angular Spreadsheet component

Protect Sheet

User Interface

Unprotect Sheet

User Interface

Unlock the particular cells in the protected sheet

Limitations of Protect Sheet

Protect Workbook

User Interface

Unprotect Workbook

User Interface

Limitations of Protect Workbook

See Also