Skip to main content

GetProtectedRange

Returns a protected range object by its title.

Syntax

expression.GetProtectedRange(sTitle);

expression - A variable that represents a ApiWorksheet class.

Parameters

NameRequired/OptionalData typeDefaultDescription
sTitleRequiredstringThe title of the protected range that will be returned.

Returns

ApiProtectedRange | null

Example

This example shows how to get an object that represents the protected range.

var oWorksheet = Api.GetActiveSheet();
oWorksheet.AddProtectedRange("protectedRange", "Sheet1!$A$1:$B$1");
var protectedRange = oWorksheet.GetProtectedRange("protectedRange");
protectedRange.SetTitle("protectedRangeNew");