Enum ProtectionType
Stay organized with collections
Save and categorize content based on your preferences.
ProtectionType
An enumeration representing the parts of a spreadsheet that can be protected from edits.
To call an enum, you call its parent class, name, and property. For example,
SpreadsheetApp.ProtectionType.RANGE.
// Remove all range protections in the spreadsheet that the user has permission
// to edit.
const ss = SpreadsheetApp.getActive();
const protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (const protection of protections) {
if (protection.canEdit()) {
protection.remove();
}
}
// Removes sheet protection from the active sheet, if the user has permission to
// edit it.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection?.canEdit()) {
protection.remove();
}
Properties
| Property | Type | Description |
RANGE | Enum | Protection for a range. |
SHEET | Enum | Protection for a sheet. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eProtectionType\u003c/code\u003e is an enum used to specify whether you are working with sheet or range protection in Google Apps Script.\u003c/p\u003e\n"],["\u003cp\u003eIt has two properties: \u003ccode\u003eSHEET\u003c/code\u003e and \u003ccode\u003eRANGE\u003c/code\u003e, that are used with the \u003ccode\u003egetProtections()\u003c/code\u003e method to retrieve the corresponding protections.\u003c/p\u003e\n"],["\u003cp\u003eYou can use \u003ccode\u003eProtectionType\u003c/code\u003e to remove or modify existing protections within your spreadsheet, given the necessary permissions.\u003c/p\u003e\n"]]],[],null,["# Enum ProtectionType\n\nProtectionType\n\nAn enumeration representing the parts of a spreadsheet that can be protected from edits.\n\nTo call an enum, you call its parent class, name, and property. For example, `\nSpreadsheetApp.ProtectionType.RANGE`.\n\n```javascript\n// Remove all range protections in the spreadsheet that the user has permission\n// to edit.\nconst ss = SpreadsheetApp.getActive();\nconst protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);\nfor (const protection of protections) {\n if (protection.canEdit()) {\n protection.remove();\n }\n}\n``` \n\n```javascript\n// Removes sheet protection from the active sheet, if the user has permission to\n// edit it.\nconst sheet = SpreadsheetApp.getActiveSheet();\nconst protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];\nif (protection?.canEdit()) {\n protection.remove();\n}\n``` \n\n### Properties\n\n| Property | Type | Description |\n|----------|--------|-------------------------|\n| `RANGE` | `Enum` | Protection for a range. |\n| `SHEET` | `Enum` | Protection for a sheet. |"]]
