Show / Hide Table of Contents

Class CellData

Data about a specific cell.

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

Properties

DataSourceFormula

Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. =SUM(DataSheet!Column).

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

DataSourceTable

A data source table anchored at this cell. The size of data source table itself is computed dynamically based on its configuration. Only the first cell of the data source table contains the data source table definition. The other cells will contain the display values of the data source table result in their effective_value fields.

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

DataValidation

A data validation rule on the cell, if any. When writing, the new data validation rule will overwrite any prior rule.

Declaration
[JsonProperty("dataValidation")]
public virtual DataValidationRule DataValidation { get; set; }
Property Value
Type Description
DataValidationRule

ETag

The ETag of the item.

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

EffectiveFormat

The effective format being used by the cell. This includes the results of applying any conditional formatting and, if the cell contains a formula, the computed number format. If the effective format is the default format, effective format will not be written. This field is read-only.

Declaration
[JsonProperty("effectiveFormat")]
public virtual CellFormat EffectiveFormat { get; set; }
Property Value
Type Description
CellFormat

EffectiveValue

The effective value of the cell. For cells with formulas, this is the calculated value. For cells with literals, this is the same as the user_entered_value. This field is read-only.

Declaration
[JsonProperty("effectiveValue")]
public virtual ExtendedValue EffectiveValue { get; set; }
Property Value
Type Description
ExtendedValue

FormattedValue

The formatted value of the cell. This is the value as it's shown to the user. This field is read-only.

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

Hyperlink

A hyperlink this cell points to, if any. If the cell contains multiple hyperlinks, this field will be empty. This field is read-only. To set it, use a =HYPERLINK formula in the userEnteredValue.formulaValue field. A cell-level link can also be set from the userEnteredFormat.textFormat field. Alternatively, set a hyperlink in the textFormatRun.format.link field that spans the entire cell.

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

Note

Any note on the cell.

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

PivotTable

A pivot table anchored at this cell. The size of pivot table itself is computed dynamically based on its data, grouping, filters, values, etc. Only the top-left cell of the pivot table contains the pivot table definition. The other cells will contain the calculated values of the results of the pivot in their effective_value fields.

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

TextFormatRuns

Runs of rich text applied to subsections of the cell. Runs are only valid on user entered strings, not formulas, bools, or numbers. Properties of a run start at a specific index in the text and continue until the next run. Runs will inherit the properties of the cell unless explicitly changed. When writing, the new runs will overwrite any prior runs. When writing a new user_entered_value, previous runs are erased.

Declaration
[JsonProperty("textFormatRuns")]
public virtual IList<TextFormatRun> TextFormatRuns { get; set; }
Property Value
Type Description
IList<TextFormatRun>

UserEnteredFormat

The format the user entered for the cell. When writing, the new format will be merged with the existing format.

Declaration
[JsonProperty("userEnteredFormat")]
public virtual CellFormat UserEnteredFormat { get; set; }
Property Value
Type Description
CellFormat

UserEnteredValue

The value the user entered in the cell. e.g., 1234, 'Hello', or =NOW() Note: Dates, Times and DateTimes are represented as doubles in serial number format.

Declaration
[JsonProperty("userEnteredValue")]
public virtual ExtendedValue UserEnteredValue { get; set; }
Property Value
Type Description
ExtendedValue

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX