ISSUE-CELLSCLOUD-13441: Add code examples for Cells Cloud SDKs.

Author: roywangaspose

.github/workflows/sdkbuild2run.yml

@@ -37,3 +37,4 @@ jobs:
         go run .\Example_MergeExcelFiles.go
         go run .\Example_SplitExcelFiles.go
         go run .\Example_CreateReportFiles.go
+        go run .\Example_Management.go

examples/Example_BatchProcessing.go

@@ -12,6 +12,8 @@ func main() {
 	CompanySalesXlsx := "CompanySales.xlsx"
 	RemoteFolder := "GoSDK"
 	RemoteOutputFolder := "GoSDK/Output"
+	// If no environment variables are configured, please obtain the ClientId and ClientSecret from https://dashboard.aspose.cloud/#/applications and replace the following values:
+	// instance  := NewCellsApiService('YourClientId','YourClientSecret')
 	instance := NewCellsApiService(os.Getenv("ProductClientId"), os.Getenv("ProductClientSecret"))
 	_, httpResponse, err := instance.UploadFile(&UploadFileRequest{UploadFiles: CompanySalesXlsx, Path: RemoteFolder + "/" + CompanySalesXlsx})
 	_, httpResponse, err = instance.UploadFile(&UploadFileRequest{UploadFiles: EmployeeSalesSummaryXlsx, Path: RemoteFolder + "/" + EmployeeSalesSummaryXlsx})
@@ -33,6 +35,7 @@ func main() {
 	} else {
 		println("Successful batch lock of Excel files.")
 	}
+
 	// Batch unlock Excel files.
 	_, httpResponse, err = instance.PostBatchUnlock(&PostBatchUnlockRequest{BatchLockRequest: &BatchLockRequest{SourceFolder: RemoteFolder, Password: "123456", OutFolder: RemoteOutputFolder, MatchCondition: &MatchConditionRequest{RegexPattern: "xlsx"}}})
 	if err != nil {

examples/Example_CloudStorageManagement.go

@@ -8,11 +8,14 @@ import (
 )
 
 func main() {
+	// If no environment variables are configured, please obtain the ClientId and ClientSecret from https://dashboard.aspose.cloud/#/applications and replace the following values:
+	// instance  := NewCellsApiService('YourClientId','YourClientSecret')
 	instance := NewCellsApiService(os.Getenv("ProductClientId"), os.Getenv("ProductClientSecret"))
 	RemoteFolder := "SDKGo"
 	CompanySalesXlsx := "CompanySales.xlsx"
 	EmployeeSalesSummaryXlsx := "EmployeeSalesSummary.xlsx"
 
+	// Check if file exists.
 	objectExists, httpResponse, err := instance.ObjectExists(&ObjectExistsRequest{Path: RemoteFolder})
 	if err != nil {
 		fmt.Print(err)
@@ -23,20 +26,26 @@ func main() {
 			httpResponse, err = instance.CreateFolder(&CreateFolderRequest{Path: RemoteFolder})
 		}
 	}
-
+	// Upload source files.
 	_, httpResponse, err = instance.UploadFile(&UploadFileRequest{UploadFiles: CompanySalesXlsx, Path: RemoteFolder + "/" + CompanySalesXlsx})
 	_, httpResponse, err = instance.UploadFile(&UploadFileRequest{UploadFiles: EmployeeSalesSummaryXlsx, Path: RemoteFolder + "/" + EmployeeSalesSummaryXlsx})
-	print("UploadFiles")
+	// Create folder on cloud storage.
 	httpResponse, err = instance.CreateFolder(&CreateFolderRequest{Path: RemoteFolder + "/CellsCloud"})
+	// Move file to other folder on cloud storage.
 	httpResponse, err = instance.MoveFile(&MoveFileRequest{SrcPath: RemoteFolder + "/" + CompanySalesXlsx, DestPath: RemoteFolder + "/CellsCloud/" + CompanySalesXlsx})
+	// Copy a file to other file on cloud storage.
 	httpResponse, err = instance.CopyFile(&CopyFileRequest{SrcPath: RemoteFolder + "/" + EmployeeSalesSummaryXlsx, DestPath: RemoteFolder + "/CellsCloud/" + EmployeeSalesSummaryXlsx})
+	// Move folder on cloud storage.
 	httpResponse, err = instance.MoveFolder(&MoveFolderRequest{SrcPath: RemoteFolder + "/CellsCloud", DestPath: RemoteFolder + "/CellsCloud2"})
+	// Get files list in a folder.
 	fileList, _, _ := instance.GetFilesList(&GetFilesListRequest{Path: RemoteFolder + "/CellsCloud2"})
 	for index, storageFile := range fileList.Value {
 		print("Get File")
 		print(index)
 		println(storageFile.Name)
 	}
+	// Delete folder on cloud storage.
 	httpResponse, err = instance.DeleteFolder(&DeleteFolderRequest{Path: RemoteFolder + "/CellsCloud2"})
+	// Delete file on cloud storage.
 	httpResponse, err = instance.DeleteFile(&DeleteFileRequest{Path: RemoteFolder + "/" + CompanySalesXlsx})
 }

examples/Example_ConvertExcel.go

@@ -11,48 +11,81 @@ import (
 func main() {
 	employeeSalesSummaryXlsx := "EmployeeSalesSummary.xlsx"
 	remoteFolder := "GoSDK"
+	// If no environment variables are configured, please obtain the ClientId and ClientSecret from https://dashboard.aspose.cloud/#/applications and replace the following values:
+	// instance  := NewCellsApiService('YourClientId','YourClientSecret')
 	instance := NewCellsApiService(os.Getenv("ProductClientId"), os.Getenv("ProductClientSecret"))
+
+	// Local file processing
 	// Convert a local Excel file to another format file directly, save to local file.
 	// Complete in one step.
 	_, httpResponse, err := instance.ConvertSpreadsheet(&ConvertSpreadsheetRequest{Spreadsheet: "EmployeeSalesSummary.xlsx", Format: "pdf"}, []CellsCloudOption{{OptionName: "LocalOutPath", OptionValue: "EmployeeSalesSummary.pdf"}}...)
 	// Completed in two steps
+	// Convert a local Excel file to byte data.
 	convertedData, httpResponse, err := instance.ConvertSpreadsheet(&ConvertSpreadsheetRequest{Spreadsheet: employeeSalesSummaryXlsx, Format: "pdf"})
 	if err != nil {
 		fmt.Print(err)
 	} else if httpResponse.StatusCode < 200 || httpResponse.StatusCode > 299 {
 		fmt.Print(httpResponse.StatusCode)
 	} else {
+		// 2 Save result to specified path.
 		file, _ := os.OpenFile("EmployeeSalesSummary1.pdf", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
 		file.Write(convertedData)
 		defer file.Close()
 	}
 
-	// Upload a local Excel file to Cells Cloud Storage.
+	// Cloud file processing
+	// Convert Cloud file to PDF
+	// 1. Upload a local Excel file to Cells Cloud Storage.
 	_, httpResponse, err = instance.UploadFile(&UploadFileRequest{UploadFiles: employeeSalesSummaryXlsx, Path: remoteFolder + "/" + employeeSalesSummaryXlsx})
-	// Convert an Excel file of Cells Cloud to another format file.
-	convertedData, httpResponse, err = instance.GetWorkbook(&GetWorkbookRequest{Name: employeeSalesSummaryXlsx, Format: "pdf", Folder: remoteFolder})
+	// 2. Convert an Excel file of Cells Cloud to another format file.
+	// 2.1 Save an Excel file of Cells Cloud as another format file of Cells Cloud.
+	_, httpResponse, err = instance.SaveSpreadsheetAs(&SaveSpreadsheetAsRequest{Name: employeeSalesSummaryXlsx, Format: "pdf", Folder: remoteFolder})
+	if err != nil {
+		println("Save as")
+		fmt.Print(err)
+	} else if httpResponse.StatusCode < 200 || httpResponse.StatusCode > 299 {
+		fmt.Print(httpResponse.StatusCode)
+	}
+
+	// 2.2 Export a worksheet of a cloud Excel file to another format file directly. Set query parameters : print_headings, one_page_per_sheet
+	convertedData, httpResponse, err = instance.ExportWorksheetAsFormat(&ExportWorksheetAsFormatRequest{Name: employeeSalesSummaryXlsx, Worksheet: "Sales", Folder: remoteFolder, Format: "pdf"}, []CellsCloudOption{{OptionName: "LocalOutPath", OptionValue: "EmployeeSalesSummary_Sales.pdf"}}...)
 	if err != nil {
 		fmt.Print(err)
 	} else if httpResponse.StatusCode < 200 || httpResponse.StatusCode > 299 {
 		fmt.Print(httpResponse.StatusCode)
 	} else {
-		file, _ := os.OpenFile("EmployeeSalesSummary2.pdf", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
+		file, _ := os.OpenFile("EmployeeSalesSummary_Sale.png", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
 		file.Write(convertedData)
 		defer file.Close()
 	}
-	//Save an Excel file of Cells Cloud as another format file of Cells Cloud.
-	_, httpResponse, err = instance.SaveSpreadsheetAs(&SaveSpreadsheetAsRequest{Name: employeeSalesSummaryXlsx, Format: "pdf", Folder: remoteFolder})
+
+	// 2.3 Export a cloud Excel file's specified worksheet page index directly to another format file. Set query parameters : print_headings, one_page_per_sheet
+	convertedData, _, _ = instance.ExportWorksheetAsFormat(&ExportWorksheetAsFormatRequest{Name: employeeSalesSummaryXlsx, Worksheet: "Sales", Folder: remoteFolder, Format: "png"})
+	file, _ := os.OpenFile("EmployeeSalesSummary_Sale_1.png", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
+	file.Write(convertedData)
+	defer file.Close()
+	// 2.4 Export a cloud Excel file's specified worksheet cells area directly to another format file. Set query parameters : print_headings, one_page_per_sheet
+	convertedData, _, _ = instance.ExportRangeAsFormat(&ExportRangeAsFormatRequest{Name: employeeSalesSummaryXlsx, Worksheet: "Sales", Folder: remoteFolder, Format: "png", Range_: "B5:L36"})
+	file, _ = os.OpenFile("EmployeeSalesSummary_Sale_Area.png", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
+	file.Write(convertedData)
+	defer file.Close()
+
+	// Get convert result
+	convertedData, httpResponse, err = instance.GetWorkbook(&GetWorkbookRequest{Name: employeeSalesSummaryXlsx, Format: "pdf", Folder: remoteFolder})
 	if err != nil {
-		println("Save as")
 		fmt.Print(err)
 	} else if httpResponse.StatusCode < 200 || httpResponse.StatusCode > 299 {
 		fmt.Print(httpResponse.StatusCode)
+	} else {
+		file, _ := os.OpenFile("EmployeeSalesSummary2.pdf", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
+		file.Write(convertedData)
+		defer file.Close()
 	}
 	// Convert a local Excel file to pdf file directly. The return value is a file info object, which includes of file name, file content(base64string), and file size.
 	var fileInfo FileInfo
 	fileInfo, httpResponse, err = instance.PostConvertWorkbookToPDF(&PostConvertWorkbookToPDFRequest{LocalPath: employeeSalesSummaryXlsx})
 	decodedData, err := base64.StdEncoding.DecodeString(string(fileInfo.FileContent))
-	file, _ := os.OpenFile("EmployeeSalesSummary3.pdf", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
+	file, _ = os.OpenFile("EmployeeSalesSummary3.pdf", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
 	file.Write(decodedData)
 	defer file.Close()
 	//Convert a local Excel file to pdf file directly. The return value is a file info object, which includes of file name, file content(base64string), and file size.
@@ -85,26 +118,5 @@ func main() {
 	file, _ = os.OpenFile("EmployeeSalesSummary.html", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
 	file.Write(decodedData)
 	defer file.Close()
-	// Convert a worksheet of a local Excel file to another format file directly. Set query parameters : print_headings, one_page_per_sheet
-	convertedData, httpResponse, err = instance.ExportWorksheetAsFormat(&ExportWorksheetAsFormatRequest{Name: employeeSalesSummaryXlsx, Worksheet: "Sales", Folder: remoteFolder, Format: "pdf"}, []CellsCloudOption{{OptionName: "LocalOutPath", OptionValue: "EmployeeSalesSummary_Sales.pdf"}}...)
-	if err != nil {
-		fmt.Print(err)
-	} else if httpResponse.StatusCode < 200 || httpResponse.StatusCode > 299 {
-		fmt.Print(httpResponse.StatusCode)
-	} else {
-		file, _ := os.OpenFile("EmployeeSalesSummary_Sale.png", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
-		file.Write(convertedData)
-		defer file.Close()
-	}
-	// Convert a local Excel file's specified worksheet page index directly to another format file. Set query parameters : print_headings, one_page_per_sheet
-	convertedData, _, _ = instance.ExportWorksheetAsFormat(&ExportWorksheetAsFormatRequest{Name: employeeSalesSummaryXlsx, Worksheet: "Sales", Folder: remoteFolder, Format: "png"})
-	file, _ = os.OpenFile("EmployeeSalesSummary_Sale_1.png", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
-	file.Write(convertedData)
-	defer file.Close()
-	//Convert a local Excel file's specified worksheet cells area directly to another format file. Set query parameters : print_headings, one_page_per_sheet
-	convertedData, _, _ = instance.ExportRangeAsFormat(&ExportRangeAsFormatRequest{Name: employeeSalesSummaryXlsx, Worksheet: "Sales", Folder: remoteFolder, Format: "png", Range_: "B5:L36"})
-	file, _ = os.OpenFile("EmployeeSalesSummary_Sale_Area.png", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
-	file.Write(convertedData)
-	defer file.Close()
 
 }

examples/Example_CreateReportFiles.go

@@ -8,8 +8,9 @@ import (
 )
 
 func main() {
+	// If no environment variables are configured, please obtain the ClientId and ClientSecret from https://dashboard.aspose.cloud/#/applications and replace the following values:
+	// instance  := NewCellsApiService('YourClientId','YourClientSecret')
 	instance := NewCellsApiService(os.Getenv("ProductClientId"), os.Getenv("ProductClientSecret"))
-	//instance = NewCellsApiService(os.Getenv("CellsCloudTestClientId"), os.Getenv("CellsCloudTestClientSecret"), "http://localhost:47987", "v3.0")
 	reportTemplate := "ProductSalteReportTemplate.xlsx"
 	reportName := "ProductSaleReport.xlsx"
 	sheetName := "SalesData"

examples/Example_Management.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	"os"
+
+	. "github.com/aspose-cells-cloud/aspose-cells-cloud-go/v25"
+)
+
+func main() {
+	// If no environment variables are configured, please obtain the ClientId and ClientSecret from https://dashboard.aspose.cloud/#/applications and replace the following values:
+	// instance  := NewCellsApiService('YourClientId','YourClientSecret')
+	instance := NewCellsApiService(os.Getenv("ProductClientId"), os.Getenv("ProductClientSecret"))
+	// Local file processing with cells cloud services.
+	// Add new worksheet to an Excel file.
+	instance.AddWorksheetToSpreadsheet(&AddWorksheetToSpreadsheetRequest{Spreadsheet: "EmployeeSalesSummary.xlsx", SheetName: "Sheet1", Position: 0}, CellsCloudOption{OptionName: "LocalOutPath", OptionValue: "EmployeeSalesSummary_Output.xlsx"})
+	// Rename worksheet in an Excel file.
+	instance.RenameWorksheetInSpreadsheet(&RenameWorksheetInSpreadsheetRequest{Spreadsheet: "EmployeeSalesSummary_Output.xlsx", SourceName: "Sheet1", TargetName: "NewSheet"}, CellsCloudOption{OptionName: "LocalOutPath", OptionValue: "EmployeeSalesSummary_Output.xlsx"})
+	// Move worksheet to new position in an Excel file.
+	instance.MoveWorksheetInSpreadsheet(&MoveWorksheetInSpreadsheetRequest{Spreadsheet: "EmployeeSalesSummary_Output.xlsx", Worksheet: "NewSheet", Position: 2}, CellsCloudOption{OptionName: "LocalOutPath", OptionValue: "EmployeeSalesSummary_Output.xlsx"})
+	// Delete worksheet in an Excel file.
+	instance.DeleteWorksheetFromSpreadsheet(&DeleteWorksheetFromSpreadsheetRequest{Spreadsheet: "EmployeeSalesSummary_Output.xlsx", SheetName: "NewSheet"}, CellsCloudOption{OptionName: "LocalOutPath", OptionValue: "EmployeeSalesSummary_Output.xlsx"})
+	// Compress an Excel file.
+	instance.CompressSpreadsheet(&CompressSpreadsheetRequest{Spreadsheet: "EmployeeSalesSummary_Output.xlsx", Level: 9}, CellsCloudOption{OptionName: "LocalOutPath", OptionValue: "EmployeeSalesSummary_Output.xlsx"})
+}

examples/Example_MergeExcelFiles.go

@@ -12,7 +12,8 @@ func main() {
 	EmployeeSalesSummaryXlsx := "EmployeeSalesSummary.xlsx"
 	CompanySalesXlsx := "CompanySales.xlsx"
 	RemoteFolder := "GoSDK"
-
+	// If no environment variables are configured, please obtain the ClientId and ClientSecret from https://dashboard.aspose.cloud/#/applications and replace the following values:
+	// instance  := NewCellsApiService('YourClientId','YourClientSecret')
 	instance := NewCellsApiService(os.Getenv("ProductClientId"), os.Getenv("ProductClientSecret"))
 	//Merge an Excel or other spreadsheet file into an existing Excel file online.
 	_, httpResponse, err := instance.UploadFile(&UploadFileRequest{UploadFiles: CompanySalesXlsx, Path: RemoteFolder + "/" + CompanySalesXlsx})

examples/Example_Protection.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"os"
+
+	. "github.com/aspose-cells-cloud/aspose-cells-cloud-go/v25"
+)
+
+func main() {
+	// If no environment variables are configured, please obtain the ClientId and ClientSecret from https://dashboard.aspose.cloud/#/applications and replace the following values:
+	// instance  := NewCellsApiService('YourClientId','YourClientSecret')
+	instance := NewCellsApiService(os.Getenv("ProductClientId"), os.Getenv("ProductClientSecret"))
+	// Local file processing with cells cloud services.
+	// Protect an Excel file.
+	instance.ProtectSpreadsheet(&ProtectSpreadsheetRequest{Spreadsheet: "EmployeeSalesSummary.xlsx", Password: "123456"}, CellsCloudOption{OptionName: "LocalOutPath", OptionValue: "EmployeeSalesSummary_Lock.xlsx"})
+	// Unprotect an Excel file.
+	instance.UnprotectSpreadsheet(&UnprotectSpreadsheetRequest{Spreadsheet: "EmployeeSalesSummary_Lock.xlsx", Password: "123456"}, CellsCloudOption{OptionName: "LocalOutPath", OptionValue: "EmployeeSalesSummary_unlock.xlsx"})
+
+}

examples/Example_QuickStart.go

@@ -8,6 +8,8 @@ import (
 )
 
 func main() {
+	// If no environment variables are configured, please obtain the ClientId and ClientSecret from https://dashboard.aspose.cloud/#/applications and replace the following values:
+	// instance  := NewCellsApiService('YourClientId','YourClientSecret')
 	instance := NewCellsApiService(os.Getenv("ProductClientId"), os.Getenv("ProductClientSecret"))
 	_, httpResponse, err := instance.ConvertSpreadsheet(&ConvertSpreadsheetRequest{Spreadsheet: "EmployeeSalesSummary.xlsx", Format: "pdf"}, []CellsCloudOption{{OptionName: "LocalOutPath", OptionValue: "EmployeeSalesSummary.pdf"}}...)
 	if err != nil {

examples/Example_SplitExcelFiles.go

@@ -12,7 +12,8 @@ func main() {
 	EmployeeSalesSummaryXlsx := "EmployeeSalesSummary.xlsx"
 	CompanySalesXlsx := "CompanySales.xlsx"
 	RemoteFolder := "GoSDK"
-
+	// If no environment variables are configured, please obtain the ClientId and ClientSecret from https://dashboard.aspose.cloud/#/applications and replace the following values:
+	// instance  := NewCellsApiService('YourClientId','YourClientSecret')
 	instance := NewCellsApiService(os.Getenv("ProductClientId"), os.Getenv("ProductClientSecret"))
 
 	//Splitting an Excel or other spreadsheet file to another format files online.