Show / Hide Table of Contents

Class ProtectedRange

A protected range.

Inheritance
object
ProtectedRange
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Sheets.v4.Data
Assembly: Google.Apis.Sheets.v4.dll
Syntax
public class ProtectedRange : IDirectResponseSchema

Properties

Description

The description of this protected range.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Editors

The users and groups with edit access to the protected range. This field is only visible to users with edit access to the protected range and the document. Editors are not supported with warning_only protection.

Declaration
[JsonProperty("editors")]
public virtual Editors Editors { get; set; }
Property Value
Type Description
Editors

NamedRangeId

The named range this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.

Declaration
[JsonProperty("namedRangeId")]
public virtual string NamedRangeId { get; set; }
Property Value
Type Description
string

ProtectedRangeId

The ID of the protected range. This field is read-only.

Declaration
[JsonProperty("protectedRangeId")]
public virtual int? ProtectedRangeId { get; set; }
Property Value
Type Description
int?

Range

The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet. When writing, only one of range or named_range_id or table_id may be set.

Declaration
[JsonProperty("range")]
public virtual GridRange Range { get; set; }
Property Value
Type Description
GridRange

RequestingUserCanEdit

True if the user who requested this protected range can edit the protected area. This field is read-only.

Declaration
[JsonProperty("requestingUserCanEdit")]
public virtual bool? RequestingUserCanEdit { get; set; }
Property Value
Type Description
bool?

TableId

The table this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.

Declaration
[JsonProperty("tableId")]
public virtual string TableId { get; set; }
Property Value
Type Description
string

UnprotectedRanges

The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets.

Declaration
[JsonProperty("unprotectedRanges")]
public virtual IList<GridRange> UnprotectedRanges { get; set; }
Property Value
Type Description
IList<GridRange>

WarningOnly

True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit. When writing: if this field is true, then editors are ignored. Additionally, if this field is changed from true to false and the editors field is not set (nor included in the field mask), then the editors will be set to all the editors in the document.

Declaration
[JsonProperty("warningOnly")]
public virtual bool? WarningOnly { get; set; }
Property Value
Type Description
bool?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX