Show / Hide Table of Contents

Class SheetProperties

Properties of a sheet.

Inheritance
object
SheetProperties
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 SheetProperties : IDirectResponseSchema

Properties

DataSourceSheetProperties

Output only. If present, the field contains DATA_SOURCE sheet specific properties.

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

ETag

The ETag of the item.

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

GridProperties

Additional properties of the sheet if this sheet is a grid. (If the sheet is an object sheet, containing a chart or image, then this field will be absent.) When writing it is an error to set any grid properties on non-grid sheets. If this sheet is a DATA_SOURCE sheet, this field is output only but contains the properties that reflect how a data source sheet is rendered in the UI, e.g. row_count.

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

Hidden

True if the sheet is hidden in the UI, false if it's visible.

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

Index

The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in "before the move" indexes. For example, if there were three sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would have to be set to 2. A sheet index update request is ignored if the requested index is identical to the sheets current index or if the requested new index is equal to the current sheet index + 1.

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

RightToLeft

True if the sheet is an RTL sheet instead of an LTR sheet.

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

SheetId

The ID of the sheet. Must be non-negative. This field cannot be changed once set.

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

SheetType

The type of sheet. Defaults to GRID. This field cannot be changed once set.

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

TabColor

The color of the tab in the UI. Deprecated: Use tab_color_style.

Declaration
[JsonProperty("tabColor")]
public virtual Color TabColor { get; set; }
Property Value
Type Description
Color

TabColorStyle

The color of the tab in the UI. If tab_color is also set, this field takes precedence.

Declaration
[JsonProperty("tabColorStyle")]
public virtual ColorStyle TabColorStyle { get; set; }
Property Value
Type Description
ColorStyle

Title

The name of the sheet.

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

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX