GenerallyPositive.GoogleSheets Class Reference

Inheritance diagram for GenerallyPositive.GoogleSheets:

Public Member Functions
IAllowSheetSelection	SaveTo (out IGPALGrid< string > gPalGrid)
IAllowDataOperations	AppendToCell (string cell)
IAllowDataOperations	PrependToCell (string cell)
IAllowDataOperations	InsertAtCell (string cell)
IAllowSheetOperations	WithWriteRange (string writeRange)
IAllowDataOperations	WriteToSheet (object sheetNameOrId)
IAllowDataOperations	AppendToSheet (object sheetNameOrId)
IAllowSpreadsheetSelection	WithWebAppUrl (string webAppUrl)
	Drives sheets through an Apps Script web app that was deployed by hand, rather than through the Sheets API. The url is the whole of what is needed: the script runs as whoever deployed it, so no credentials, cloud project or OAuth client are involved. This is the route for someone who uses Google Sheets but does not want a Google Cloud project. The script to paste is GPAL's own gateway, the same one WithCredentials deploys for itself.
IAllowSpreadsheetSelection	WithCredentials (ICredentials credentials)
IAllowSheetSelection	WithSpreadsheet (string spreadsheetIdOrTitle)
IAllowSheetOperations	CreateSheet (string sheetName)
IAllowSheetSelection	SetSheetName (string newSheetName)
IAllowSheetSelection	SetSpreadsheetTitle (string title)
IAllowInDataOperations	WithSheet (object sheetNameOrId)
IAllowDataOperations	WithReadRange (string readRange)
IAllowDataOperations	WithData (IGPALGrid< string > data)
IAllowSheetSelection	DeleteSheet (object sheetNameOrId)
IAllowSheetSelection	ListSheets (out IEnumerable<(string name, int sheetId)> sheets)
IAllowInsertSettings	WithInsertPosition (int position)
IAllowInsertSettings	WithInsertSeparator (string separator)
IAllowDataOperations	CalculateSum (out string result)
IAllowDataOperations	CalculateCount (out string result)
IAllowFormatSettings	WithFormatType (FormatType formatType)
IAllowFormatRange	WithFormatValue (object formatValue)
IAllowFormatRange	WithAlignmentFormatValue (HorizontalAlignmentType alignment)
IAllowFormatRange	WithAlignmentFormatValue (VerticalAlignmentType alignment)
IAllowFormatRange	WithNumberFormatValue (NumberFormatType numberFormat)
IAllowFormatRange	WithTextRotationFormatValue (TextRotationType rotation)
IAllowFormatRange	WithColorFormatValue (System.Drawing.Color color)
IAllowInDataOperations	FormatRange (string range)
IAllowTriggerSettings	WithTriggerFunction (string functionName)
IAllowTriggerSettings	WithTriggerSchedule (TriggerScheduleType schedule)
IAllowDataOperations	CreateTrigger (GoogleTriggerType triggerType)
string	SetupCloudProject (string projectName)
string	GetOrCreateScriptProject (string cloudProjectId, string scriptTitle)
IAllowScriptOperations	WithProjectId (string projectId)
IAllowScriptOperations	WithScriptName (string scriptName)
IAllowScriptOperations	WithScriptAccess (ScriptAccessType access)
IAllowScriptOperations	WithExecuteAs (ExecuteAsType executeAs)
IAllowScriptOperations	WithDeploymentDescription (string description)
IAllowScriptOperations	WithVersionNumber (int versionNumber)
IAllowDeployWebApp	UploadScript (string scriptContent)
IAllowDeployWebApp	UploadScript (GPALFile scriptFile)
IAllowDataOperations	DeployScriptAsWebApp (out string webAppUrl)
IAllowSheetSelection	SaveTo (GPALFile gPALFile)
IGoogleSheets	ToGPALObject ()
Public Member Functions inherited from GenerallyPositive.Browser.IAllowFormatSettings
IAllowFormatRange	WithColorFormatValue (Color color)

Detailed Description

Definition at line 54 of file GoogleSheets.cs.

Member Function Documentation

AppendToCell()

IAllowDataOperations GenerallyPositive.GoogleSheets.AppendToCell

(

string

cell

)

Implements GenerallyPositive.Browser.IAllowDataOperations.

Definition at line 325 of file GoogleSheets.cs.

AppendToSheet()

IAllowDataOperations GenerallyPositive.GoogleSheets.AppendToSheet

(

object

sheetNameOrId

)

Definition at line 650 of file GoogleSheets.cs.

CalculateCount()

IAllowDataOperations GenerallyPositive.GoogleSheets.CalculateCount

(

out string

result

)

Implements GenerallyPositive.Browser.IAllowDataOperations.

Definition at line 1406 of file GoogleSheets.cs.

CalculateSum()

IAllowDataOperations GenerallyPositive.GoogleSheets.CalculateSum

(

out string

result

)

Implements GenerallyPositive.Browser.IAllowDataOperations.

Definition at line 1373 of file GoogleSheets.cs.

CreateSheet()

IAllowSheetOperations GenerallyPositive.GoogleSheets.CreateSheet

(

string

sheetName

)

Definition at line 928 of file GoogleSheets.cs.

CreateTrigger()

IAllowDataOperations GenerallyPositive.GoogleSheets.CreateTrigger

(

GoogleTriggerType

triggerType

)

Implements GenerallyPositive.Browser.IAllowTriggerSettings.

Definition at line 1804 of file GoogleSheets.cs.

DeleteSheet()

IAllowSheetSelection GenerallyPositive.GoogleSheets.DeleteSheet

(

object

sheetNameOrId

)

Implements GenerallyPositive.Browser.IAllowSheetOperations.

Definition at line 1198 of file GoogleSheets.cs.

DeployScriptAsWebApp()

IAllowDataOperations GenerallyPositive.GoogleSheets.DeployScriptAsWebApp

(

out string

webAppUrl

)

Implements GenerallyPositive.Browser.IAllowDeployWebApp.

Definition at line 2077 of file GoogleSheets.cs.

FormatRange()

IAllowInDataOperations GenerallyPositive.GoogleSheets.FormatRange

(

string

range

)

Implements GenerallyPositive.Browser.IAllowFormatRange.

Definition at line 1478 of file GoogleSheets.cs.

GetOrCreateScriptProject()

string GenerallyPositive.GoogleSheets.GetOrCreateScriptProject	(	string	cloudProjectId,
		string	scriptTitle )

Definition at line 1877 of file GoogleSheets.cs.

InsertAtCell()

IAllowDataOperations GenerallyPositive.GoogleSheets.InsertAtCell

(

string

cell

)

Implements GenerallyPositive.Browser.IAllowInsertSettings.

Definition at line 494 of file GoogleSheets.cs.

ListSheets()

IAllowSheetSelection GenerallyPositive.GoogleSheets.ListSheets

(

out IEnumerable<(string name, int sheetId)>

sheets

)

Implements GenerallyPositive.Browser.IAllowSheetSelection.

Definition at line 1296 of file GoogleSheets.cs.

PrependToCell()

IAllowDataOperations GenerallyPositive.GoogleSheets.PrependToCell

(

string

cell

)

Implements GenerallyPositive.Browser.IAllowDataOperations.

Definition at line 410 of file GoogleSheets.cs.

SaveTo() [1/2]

IAllowSheetSelection GenerallyPositive.GoogleSheets.SaveTo

(

GPALFile

gPALFile

)

Implements GenerallyPositive.Browser.IAllowGoogleSheetsSaveTo.

Definition at line 2230 of file GoogleSheets.cs.

SaveTo() [2/2]

IAllowSheetSelection GenerallyPositive.GoogleSheets.SaveTo

(

out IGPALGrid< string >

gPalGrid

)

Implements GenerallyPositive.Browser.IAllowGoogleSheetsSaveTo.

Definition at line 291 of file GoogleSheets.cs.

SetSheetName()

IAllowSheetSelection GenerallyPositive.GoogleSheets.SetSheetName

(

string

newSheetName

)

Implements GenerallyPositive.Browser.IAllowInDataOperations.

Definition at line 972 of file GoogleSheets.cs.

SetSpreadsheetTitle()

IAllowSheetSelection GenerallyPositive.GoogleSheets.SetSpreadsheetTitle

(

string

title

)

Implements GenerallyPositive.Browser.IAllowSheetSelection.

Definition at line 1009 of file GoogleSheets.cs.

SetupCloudProject()

string GenerallyPositive.GoogleSheets.SetupCloudProject

(

string

projectName

)

Definition at line 1843 of file GoogleSheets.cs.

ToGPALObject()

IGoogleSheets GenerallyPositive.GoogleSheets.ToGPALObject

(

)

Implements GenerallyPositive.Browser.IAllowToGPALObject< TResult >.

Definition at line 2274 of file GoogleSheets.cs.

UploadScript() [1/2]

IAllowDeployWebApp GenerallyPositive.GoogleSheets.UploadScript

(

GPALFile

scriptFile

)

Implements GenerallyPositive.Browser.IAllowScriptOperations.

Definition at line 2055 of file GoogleSheets.cs.

UploadScript() [2/2]

IAllowDeployWebApp GenerallyPositive.GoogleSheets.UploadScript

(

string

scriptContent

)

Implements GenerallyPositive.Browser.IAllowScriptOperations.

Definition at line 2007 of file GoogleSheets.cs.

WithAlignmentFormatValue() [1/2]

IAllowFormatRange GenerallyPositive.GoogleSheets.WithAlignmentFormatValue

(

HorizontalAlignmentType

alignment

)

Implements GenerallyPositive.Browser.IAllowFormatSettings.

Definition at line 1448 of file GoogleSheets.cs.

WithAlignmentFormatValue() [2/2]

IAllowFormatRange GenerallyPositive.GoogleSheets.WithAlignmentFormatValue

(

VerticalAlignmentType

alignment

)

Implements GenerallyPositive.Browser.IAllowFormatSettings.

Definition at line 1454 of file GoogleSheets.cs.

WithColorFormatValue()

IAllowFormatRange GenerallyPositive.GoogleSheets.WithColorFormatValue

(

System.Drawing.Color

color

)

Definition at line 1472 of file GoogleSheets.cs.

WithCredentials()

IAllowSpreadsheetSelection GenerallyPositive.GoogleSheets.WithCredentials

(

ICredentials

credentials

)

Implements GenerallyPositive.Browser.IGoogleSheets.

Definition at line 848 of file GoogleSheets.cs.

WithData()

IAllowDataOperations GenerallyPositive.GoogleSheets.WithData

(

IGPALGrid< string >

data

)

Implements GenerallyPositive.Browser.IAllowInDataOperations.

Definition at line 1192 of file GoogleSheets.cs.

WithDeploymentDescription()

IAllowScriptOperations GenerallyPositive.GoogleSheets.WithDeploymentDescription

(

string

description

)

Implements GenerallyPositive.Browser.IAllowScriptOperations.

Definition at line 1979 of file GoogleSheets.cs.

WithExecuteAs()

IAllowScriptOperations GenerallyPositive.GoogleSheets.WithExecuteAs

(

ExecuteAsType

executeAs

)

Implements GenerallyPositive.Browser.IAllowScriptOperations.

Definition at line 1973 of file GoogleSheets.cs.

WithFormatType()

IAllowFormatSettings GenerallyPositive.GoogleSheets.WithFormatType

(

FormatType

formatType

)

Implements GenerallyPositive.Browser.IAllowInDataOperations.

Definition at line 1436 of file GoogleSheets.cs.

WithFormatValue()

IAllowFormatRange GenerallyPositive.GoogleSheets.WithFormatValue

(

object

formatValue

)

Implements GenerallyPositive.Browser.IAllowFormatSettings.

Definition at line 1442 of file GoogleSheets.cs.

WithInsertPosition()

IAllowInsertSettings GenerallyPositive.GoogleSheets.WithInsertPosition

(

int

position

)

Implements GenerallyPositive.Browser.IAllowInsertSettings.

Definition at line 1361 of file GoogleSheets.cs.

WithInsertSeparator()

IAllowInsertSettings GenerallyPositive.GoogleSheets.WithInsertSeparator

(

string

separator

)

Implements GenerallyPositive.Browser.IAllowInsertSettings.

Definition at line 1367 of file GoogleSheets.cs.

WithNumberFormatValue()

IAllowFormatRange GenerallyPositive.GoogleSheets.WithNumberFormatValue

(

NumberFormatType

numberFormat

)

Implements GenerallyPositive.Browser.IAllowFormatSettings.

Definition at line 1460 of file GoogleSheets.cs.

WithProjectId()

IAllowScriptOperations GenerallyPositive.GoogleSheets.WithProjectId

(

string

projectId

)

Implements GenerallyPositive.Browser.IAllowScriptOperations.

Definition at line 1947 of file GoogleSheets.cs.

WithReadRange()

IAllowDataOperations GenerallyPositive.GoogleSheets.WithReadRange

(

string

readRange

)

Implements GenerallyPositive.Browser.IAllowInDataOperations.

Definition at line 1180 of file GoogleSheets.cs.

WithScriptAccess()

IAllowScriptOperations GenerallyPositive.GoogleSheets.WithScriptAccess

(

ScriptAccessType

access

)

Implements GenerallyPositive.Browser.IAllowScriptOperations.

Definition at line 1967 of file GoogleSheets.cs.

WithScriptName()

IAllowScriptOperations GenerallyPositive.GoogleSheets.WithScriptName

(

string

scriptName

)

Implements GenerallyPositive.Browser.IAllowScriptOperations.

Definition at line 1957 of file GoogleSheets.cs.

WithSheet()

IAllowInDataOperations GenerallyPositive.GoogleSheets.WithSheet

(

object

sheetNameOrId

)

Implements GenerallyPositive.Browser.IAllowSheetSelection.

Definition at line 1047 of file GoogleSheets.cs.

WithSpreadsheet()

IAllowSheetSelection GenerallyPositive.GoogleSheets.WithSpreadsheet

(

string

spreadsheetIdOrTitle

)

Implements GenerallyPositive.Browser.IAllowSpreadsheetSelection.

Definition at line 856 of file GoogleSheets.cs.

WithTextRotationFormatValue()

IAllowFormatRange GenerallyPositive.GoogleSheets.WithTextRotationFormatValue

(

TextRotationType

rotation

)

Implements GenerallyPositive.Browser.IAllowFormatSettings.

Definition at line 1466 of file GoogleSheets.cs.

WithTriggerFunction()

IAllowTriggerSettings GenerallyPositive.GoogleSheets.WithTriggerFunction

(

string

functionName

)

Implements GenerallyPositive.Browser.IAllowWithTriggerFunction.

Definition at line 1788 of file GoogleSheets.cs.

WithTriggerSchedule()

IAllowTriggerSettings GenerallyPositive.GoogleSheets.WithTriggerSchedule

(

TriggerScheduleType

schedule

)

Implements GenerallyPositive.Browser.IAllowTriggerSettings.

Definition at line 1798 of file GoogleSheets.cs.

WithVersionNumber()

IAllowScriptOperations GenerallyPositive.GoogleSheets.WithVersionNumber

(

int

versionNumber

)

Implements GenerallyPositive.Browser.IAllowScriptOperations.

Definition at line 1993 of file GoogleSheets.cs.

WithWebAppUrl()

IAllowSpreadsheetSelection GenerallyPositive.GoogleSheets.WithWebAppUrl

(

string

webAppUrl

)

Drives sheets through an Apps Script web app that was deployed by hand, rather than through the Sheets API. The url is the whole of what is needed: the script runs as whoever deployed it, so no credentials, cloud project or OAuth client are involved.

This is the route for someone who uses Google Sheets but does not want a Google Cloud project. The script to paste is GPAL's own gateway, the same one WithCredentials deploys for itself.

Parameters

webAppUrl

The /exec url the Apps Script deployment handed back.

Returns

Fluent interface to choose a spreadsheet

Implements GenerallyPositive.Browser.IGoogleSheets.

Definition at line 826 of file GoogleSheets.cs.

WithWriteRange()

IAllowSheetOperations GenerallyPositive.GoogleSheets.WithWriteRange

(

string

writeRange

)

Implements GenerallyPositive.Browser.IAllowDataOperations.

Definition at line 579 of file GoogleSheets.cs.

WriteToSheet()

IAllowDataOperations GenerallyPositive.GoogleSheets.WriteToSheet

(

object

sheetNameOrId

)

Implements GenerallyPositive.Browser.IAllowSheetOperations.

Definition at line 592 of file GoogleSheets.cs.

---

The documentation for this class was generated from the following file:

• Common/GoogleSheets.cs