Working with worksheet backgrounds Leave feedback
The API allows you to extract information about all the worksheet backgrounds in an Excel document as shown in the following code sample.
advanced_usage.add_watermarks_to_spreadsheets.SpreadsheetGetInformationOfWorksheetBackgrounds
SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
// Specify an absolute or relative path to your document. Ex: "C:\\Docs\\spreadsheet.xlsx"
Watermarker watermarker = new Watermarker("spreadsheet.xlsx", loadOptions);
SpreadsheetContent content = watermarker.getContent(SpreadsheetContent.class);
for (SpreadsheetWorksheet worksheet : content.getWorksheets())
{
if (worksheet.getBackgroundImage() != null)
{
System.out.println(worksheet.getBackgroundImage().getWidth());
System.out.println(worksheet.getBackgroundImage().getHeight());
System.out.println(worksheet.getBackgroundImage().getBytes().length);
}
}
watermarker.close();
Following code sample can be used to remove the background of a particular worksheet.
advanced_usage.add_watermarks_to_spreadsheets.SpreadsheetRemoveWorksheetBackground
SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
// Specify an absolute or relative path to your document. Ex: "C:\\Docs\\spreadsheet.xlsx"
Watermarker watermarker = new Watermarker("spreadsheet.xlsx", loadOptions);
SpreadsheetContent content = watermarker.getContent(SpreadsheetContent.class);
content.getWorksheets().get_Item(0).setBackgroundImage(null);
watermarker.save("spreadsheet.xlsx");
watermarker.close();
You can add watermark to the background images that belong to an Excel document as shown in the below code sample.
advanced_usage.add_watermarks_to_spreadsheets.SpreadsheetAddWatermarkToBackgroundImages
SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
// Specify an absolute or relative path to your document. Ex: "C:\\Docs\\spreadsheet.xlsx"
Watermarker watermarker = new Watermarker("spreadsheet.xlsx", loadOptions);
// Initialize image or text watermark
TextWatermark watermark = new TextWatermark("Protected image", new Font("Arial", 8));
watermark.setHorizontalAlignment(HorizontalAlignment.Center);
watermark.setVerticalAlignment(VerticalAlignment.Center);
watermark.setRotateAngle(45);
watermark.setSizingType(SizingType.ScaleToParentDimensions);
watermark.setScaleFactor(1);
SpreadsheetContent content = watermarker.getContent(SpreadsheetContent.class);
for (SpreadsheetWorksheet worksheet : content.getWorksheets())
{
if (worksheet.getBackgroundImage() != null)
{
// Add watermark to the image
worksheet.getBackgroundImage().add(watermark);
}
}
watermarker.save("spreadsheet.xlsx");
watermarker.close();
GroupDocs.Watermark for Java also allows you to set the background image for a chart inside an Excel document. Following code sample shows how to achieve this functionality.
advanced_usage.add_watermarks_to_spreadsheets.SpreadsheetSetBackgroundImageForChart
SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
// Specify an absolute or relative path to your document. Ex: "C:\\Docs\\spreadsheet.xlsx"
Watermarker watermarker = new Watermarker("spreadsheet.xlsx", loadOptions);
SpreadsheetContent content = watermarker.getContent(SpreadsheetContent.class);
File imageFile = new File("test.png");
byte[] imageBytes = new byte[(int) imageFile.length()];
InputStream imageInputStream = new FileInputStream(imageFile);
imageInputStream.read(imageBytes);
imageInputStream.close();
content.getWorksheets().get_Item(0).getCharts().get_Item(0).getImageFillFormat().setBackgroundImage(new SpreadsheetWatermarkableImage(imageBytes));
content.getWorksheets().get_Item(0).getCharts().get_Item(0).getImageFillFormat().setTransparency(0.5);
content.getWorksheets().get_Item(0).getCharts().get_Item(0).getImageFillFormat().setTileAsTexture(true);
watermarker.save("spreadsheet.xlsx");
watermarker.close();
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.
