Class Spreadsheet
Resource that represents a spreadsheet.
Inheritance
Inherited Members
Namespace: StansAssets.GoogleDoc
Assembly: cs.temp.dll.dll
Syntax
public class Spreadsheet
Constructors
Spreadsheet(String)
Declaration
public Spreadsheet(string id)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | Spreadsheet Id |
Properties
Id
The ID of the spreadsheet.
Declaration
public string Id { get; }
Property Value
Type | Description |
---|---|
System.String |
InProgress
Property is true
if State is equals to InProgress, otherwise 'false'
Declaration
public bool InProgress { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
LastSyncMachineName
The name of the Machine where last sync was performed.
Declaration
public string LastSyncMachineName { get; }
Property Value
Type | Description |
---|---|
System.String |
Name
The name of the spreadsheet.
Declaration
public string Name { get; }
Property Value
Type | Description |
---|---|
System.String |
NotSynced
Declaration
public bool NotSynced { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Sheets
The spreadsheet sheets list.
Declaration
public IEnumerable<Sheet> Sheets { get; }
Property Value
Type | Description |
---|---|
IEnumerable<Sheet> |
State
The spreadsheet sync state.
Declaration
public Spreadsheet.SyncState State { get; }
Property Value
Type | Description |
---|---|
Spreadsheet.SyncState |
SyncDateTime
The
Declaration
public DateTime SyncDateTime { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Synced
Declaration
public bool Synced { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
SyncedWithError
Property is true
if State is equals to SyncedWithError, otherwise 'false'
Declaration
public bool SyncedWithError { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
SyncErrorMassage
If last spreadsheet sync attempt was finished with an error,
this property will contains a string with error details.
The default value is null
.
Declaration
public string SyncErrorMassage { get; }
Property Value
Type | Description |
---|---|
System.String |
Url
The spreadsheet absolute web URL.
Declaration
public string Url { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
GetSheet(Int32)
Gets spreadsheet sheet by it's id.
Declaration
public Sheet GetSheet(int sheetId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | sheetId | A sheet id. |
Returns
Type | Description |
---|---|
Sheet | Returns the Sheets object
if spreadsheet contains a sheet with specified id, otherwise |
GetSheet(String)
Gets first spreadsheet sheet by it's name.
Declaration
public Sheet GetSheet(string sheetName)
Parameters
Type | Name | Description |
---|---|---|
System.String | sheetName | A sheet name. |
Returns
Type | Description |
---|---|
Sheet | Returns the Sheets object
if spreadsheet contains a sheet with the name, otherwise |
HasSheet(Int32)
Returns true
if spreadsheet contains a sheet with specified id, otherwise false
.
Declaration
public bool HasSheet(int sheetId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | sheetId | A sheet id. |
Returns
Type | Description |
---|---|
System.Boolean |
|
HasSheet(String)
Returns true
if spreadsheet contains a sheet with the name, otherwise false
.
Declaration
public bool HasSheet(string sheetName)
Parameters
Type | Name | Description |
---|---|---|
System.String | sheetName | A sheet name. |
Returns
Type | Description |
---|---|
System.Boolean |
|
Events
OnSyncStateChange
An event to track spreadsheet sync state.
Declaration
public event Action<Spreadsheet> OnSyncStateChange
Event Type
Type | Description |
---|---|
Action<Spreadsheet> |