Set background on an Excel worksheet

This REST API indicates add worksheet background image.

RSET API

 
PUT http://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/background

The request parameters are:

Parameter Name	Type	Path/Query String/HTTPBody	Description
name	string	path
sheetName	string	path
png		body
folder	string	query
storageName	string	query	storage name.

The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

You can use cURL command-line tool to access Aspose.Cells web services easily. The following example shows how to make calls to Cloud API with cURL.

Request

 
curl -v "http://api.aspose.com/v3.0/cells/myWorkbook.xlsx/worksheets/Sheet1/background" \
-X PUT \
-T Creative.jpg \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"

Response

{
"Code": 200,
"Status": "OK"
}

Cloud SDK Family

Using an SDK is the best way to speed up the development. An SDK takes care of low-level details and lets you focus on your project tasks. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to make calls to Aspose.Cells web services using various SDKs:

	// For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-dotnet/
	namespace Aspose.Cells.Cloud.SDK.Example
	{
	using Aspose.Cells.Cloud.SDK.Api;
	using Aspose.Cells.Cloud.SDK.Request;
	using System;

	public partial class CellsApiExample
	{
	public void PutWorksheetBackgroundExample()
	{
	CellsApi cellsApi = new CellsApi(Environment.GetEnvironmentVariable("CellsCloudTestClientId"), Environment.GetEnvironmentVariable("CellsCloudTestClientSecret"));
	PutWorksheetBackgroundRequest request = new PutWorksheetBackgroundRequest { name = "Book1.xlsx", sheetName = "Sheet1", folder = "TestData/In" };
	cellsApi.PutWorksheetBackground(request);
	}
	}
	}
	// Obsolete
	//CellsWorksheetsApi instance = new CellsWorksheetsApi(GetConfiguration());
	//string name = "Book1.xlsx";
	//string sheetName = "Sheet1";
	//string folder = null;
	//UpdateDataFile(folder, name);
	//var response = instance.CellsWorksheetsPutWorksheetBackground(name, sheetName, File.ReadAllBytes(@"c:\Data\WaterMark.png"), folder);

view raw Examples-.NET-CellsWorksheetsPutWorkSheetBackground.cs hosted with ❤ by GitHub

Java

PHP

	<?php
	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-php
	require_once('vendor\autoload.php');
	use \Aspose\Cells\Cloud\Api\CellsApi;
	use \Aspose\Cells\Cloud\Request\PutWorksheetBackgroundRequest;

	class Worksheet {

	public $instance;

	public function __construct() {
	$this->instance = new CellsApi(getenv("CellsCloudClientId"),getenv("CellsCloudClientSecret"),"v3.0",getenv("CellsCloudApiBaseUrl"));
	}

	public function putWorkSheetBackground() {
	$remoteFolder = "TestData/In";
	$localName = "Book1.xlsx";
	$waterMarkPNG = "WaterMark.png";
	$remoteName = "Book1.xlsx";
	$request = new PutWorksheetBackgroundRequest();
	$request->setName( $remoteName);
	$request->setSheetName( "Sheet1");
	$request->setPicPath( $remoteFolder . "/WaterMark.png");
	$request->setFolder( $remoteFolder);
	$request->setStorageName( "");
	$this->instance->putWorksheetBackground($request);
	}
	}

	$worksheet = new Worksheet();
	$worksheet->putWorkSheetBackground();

	?>

view raw Examples-PHP-Worksheet-PutWorkSheetBackground-.php hosted with ❤ by GitHub

Ruby

	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-ruby
	require 'aspose_cells_cloud'

	class Worksheet

	include AsposeCellsCloud

	def initialize
	@instance = AsposeCellsCloud::CellsApi.new($client_id,$client_secret,$api_version,$baseurl)
	end

	# Set worksheet background image.
	def set_worksheet_background_image
	name = $BOOK1
	sheet_name = $SHEET1
	aFile = File.new(File.expand_path("data/WaterMark.png"),"r")
	png = aFile.sysread(aFile.size)
	aFile.close
	folder = $TEMPFOLDER
	result = @instance.delete_file( folder+"/"+name)
	result = @instance.upload_file( folder+"/"+name, ::File.open(File.expand_path("data/"+name),"r") {\|io\| io.read(io.size) })
	expect(result.uploaded.size).to be > 0
	result = @instance.cells_worksheets_put_worksheet_background(name, sheet_name, png, { :folder=>folder})
	expect(result.code).to eql(200)
	end

	end

	worksheet = Worksheet.new()
	puts worksheet.set_worksheet_background_image

view raw Examples-Ruby-Worksheet-set_worksheet_background_image-.rb hosted with ❤ by GitHub

Python

	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-python
	import os

	from asposecellscloud.apis.cells_api import CellsApi
	from asposecellscloud.models import *
	from asposecellscloud.requests import *

	api = CellsApi(os.getenv('CellsCloudClientId'),os.getenv('CellsCloudClientSecret'),"v3.0",os.getenv('CellsCloudApiBaseUrl'))
	request = PutWorksheetBackgroundRequest( 'Book1.xlsx', 'Sheet1',pic_path= 'PythonTest' + '/WaterMark.png',folder= 'PythonTest',storage_name= '')
	api.put_worksheet_background(request)

view raw SetBackgroundOrWatermark.py hosted with ❤ by GitHub

Node.js

	const { CellsApi, UploadFileRequest, CellsWorksheets_PutWorksheetBackgroundRequest } = require("asposecellscloud");
	const clientId = process.env.CellsCloudClientId;
	const clientSecret = process.env.CellsCloudClientSecret;
	const ApiURL = process.env.CellsCloudApiBaseUrl;
	const fs = require('fs');
	const path = require('path');
	const cellsApi = new CellsApi(clientId, clientSecret,"v3.0",ApiURL);
	const localPath = "D:/aspose-cells-cloud-node/TestData/"

	const filename = "Book1.xlsx";
	const data =fs.createReadStream(path.join(localPath, filename));
	const png ="WaterMark.png";
	const req = new UploadFileRequest({
	path: "Temp/" + filename,
	file: data
	});
	cellsApi.uploadFile(req)
	.then((result) => {

	const req = new CellsWorksheets_PutWorksheetBackgroundRequest();
	req.name = filename;
	req.sheetName = "Sheet1";
	req.png = localPath + png;
	req.folder = "Temp";
	cellsApi.cellsWorksheetsPutWorksheetBackground(req)
	.then((result) => {
	console.log("successful")

	}).catch((error) => {
	console.error('Unhandled Promise Rejection:', error);
	})
	})

view raw Examples-Node.js-SDK-Worksheet-SetWatermarkBackground-1.js hosted with ❤ by GitHub

Android

Swift

Perl

	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-perl/
	use strict;
	use warnings;
	use utf8;
	use File::Slurp;
	use MIME::Base64;
	use AsposeCellsCloud::CellsApi;
	my $config = AsposeCellsCloud::Configuration->new( client_id => $ENV{'ProductClientId'}, client_secret => $ENV{'ProductClientSecret'});
	my $instance = AsposeCellsCloud::CellsApi->new(AsposeCellsCloud::ApiClient->new( $config));

	my $remoteFolder = 'TestData/In';
	my $waterMarkPNG = 'WaterMark.png';
	my $remoteName = 'Book1.xlsx';
	my $request = AsposeCellsCloud::Request::PutWorksheetBackgroundRequest->new();
	$request->{name} = $remoteName;
	$request->{sheet_name} = 'Sheet1';
	$request->{pic_path} = $remoteFolder . '/WaterMark.png';
	$request->{folder} = $remoteFolder;
	$request->{storage_name} = '';
	my $result = $api->put_worksheet_background(request=> $request);

view raw Examples-Perl-Worksheet-SetWatermarkBackground-1.pl hosted with ❤ by GitHub

Delete background on an Excel worksheet