Working with worksheet backgrounds Leave feedback
On this page
Each worksheet can have a background image, available through SpreadsheetContent.worksheets[i].background_image. It is None when the worksheet has no background.
from groupdocs.watermark import Watermarker
from groupdocs.watermark.options.spreadsheet import SpreadsheetLoadOptions
def extract_worksheet_backgrounds():
with Watermarker("./spreadsheet.xlsx", SpreadsheetLoadOptions()) as watermarker:
content = watermarker.get_content()
for i, worksheet in enumerate(content.worksheets):
background = worksheet.background_image
if background is not None:
print(f"Worksheet {i}: background {background.width}x{background.height}")
else:
print(f"Worksheet {i}: no background")
if __name__ == "__main__":
extract_worksheet_backgrounds()
spreadsheet.xlsx is the sample file used in this example. Click here to download it.
Worksheet 0: no background
Worksheet 1: no background
Set background_image to None:
from groupdocs.watermark import Watermarker
from groupdocs.watermark.options.spreadsheet import SpreadsheetLoadOptions
def remove_worksheet_background():
with Watermarker("./spreadsheet.xlsx", SpreadsheetLoadOptions()) as watermarker:
content = watermarker.get_content()
content.worksheets[0].background_image = None
watermarker.save("./output.xlsx")
if __name__ == "__main__":
remove_worksheet_background()
spreadsheet.xlsx is the sample file used in this example. Click here to download it.
Binary file (XLSX, 9 KB)
Add a watermark to every worksheet that has a background image:
from groupdocs.watermark import Watermarker
from groupdocs.watermark.watermarks import TextWatermark, Font, Color
from groupdocs.watermark.options.spreadsheet import SpreadsheetLoadOptions
def watermark_worksheet_backgrounds():
with Watermarker("./spreadsheet.xlsx", SpreadsheetLoadOptions()) as watermarker:
watermark = TextWatermark("CONFIDENTIAL", Font("Arial", 19.0))
watermark.foreground_color = Color.red
content = watermarker.get_content()
for worksheet in content.worksheets:
if worksheet.background_image is not None:
worksheet.background_image.add(watermark)
watermarker.save("./output.xlsx")
if __name__ == "__main__":
watermark_worksheet_backgrounds()
spreadsheet.xlsx is the sample file used in this example. Click here to download it.
Binary file (XLSX, 9 KB)
To add a fresh worksheet background watermark, use SpreadsheetBackgroundWatermarkOptions when calling add().
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
