com.groupdocs.watermark.contents

Class SpreadsheetContent

java.lang.Object

com.groupdocs.watermark.contents.ContentPart

com.groupdocs.watermark.contents.Content

com.groupdocs.watermark.contents.SpreadsheetContent

All Implemented Interfaces:

IEncryptable, Closeable, AutoCloseable

public class SpreadsheetContent
extends Content
implements IEncryptable

Represents an Excel document where a watermark can be placed.

Learn more:

• Add watermarks to spreadsheet documents
• Shapes in spreadsheet document
• Working with spreadsheet document attachments
• Working with worksheet backgrounds
• Working with worksheet headers and footers

The following example demonstrates how to load and save Excel content of any supported type.

   SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
   Watermarker watermarker = new Watermarker("D:\\input.xls", loadOptions);
 
   // Use add method to add watermark to a particular or all worksheets.
 
   // Save changes.
   watermarker.save("D:\\output.xls");
   watermarker.close();
 

Constructor Summary

Constructors

Constructor and Description
SpreadsheetContent(StreamContainer stream, StrategyManager<Integer> strategyManager, com.aspose.cells.FileFormatInfo fileFormatInfo, SpreadsheetLoadOptions spreadsheetLoadOptions, WatermarkerSettings watermarkerSettings)

Method Summary

Modifier and Type	Method and Description
void	add(Watermark watermark, WatermarkOptions options)
void	addModernWordArtWatermark(TextWatermark watermark, SpreadsheetShapeSettings shapeSettings)
void	addWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects)
void	addWatermarkAsBackground(Watermark watermark, int backgroundWidth, int backgroundHeight)
void	addWatermarkIntoHeaderFooter(Watermark watermark)
void	decrypt() Decrypts the document.
protected void	dispose(boolean disposing) Releases all resources used by the SpreadsheetContent
void	encrypt(String password) Encrypts the content.
void	generatePreview(PreviewOptions previewOptions)
com.aspose.cells.Workbook	getAsposeCellsWorkbook()
IDocumentInfo	getDocumentInfo()
FileType	getFileType()
SpreadsheetWorksheetCollection	getWorksheets() Gets the collection of all worksheets of this SpreadsheetContent.
void	performSave(OutputStream stream)
void	performSave(OutputStream stream, SaveOptions saveOptions)
void	performSave(String filePath)
void	performSave(String filePath, SaveOptions saveOptions)

Methods inherited from class com.groupdocs.watermark.contents.Content

close, dispose, getInfo, getInfo, getSearchableObjects, getStream, getWatermarkerSettings, registerDisposableResource, save, save, save, save, setSearchableObjects

Methods inherited from class com.groupdocs.watermark.contents.ContentPart

addWatermark, afterWatermarkAdding, checkWatermarkingLicenseRestrictions, findImages, findImages, getParts, getSearchWatermarksInParts, getStrategyManager, getTopParent, search, search, setParts, tryGetWatermarkerSettings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpreadsheetContent

public SpreadsheetContent(StreamContainer stream,
                          StrategyManager<Integer> strategyManager,
                          com.aspose.cells.FileFormatInfo fileFormatInfo,
                          SpreadsheetLoadOptions spreadsheetLoadOptions,
                          WatermarkerSettings watermarkerSettings)

Method Detail

add

public void add(Watermark watermark,
                WatermarkOptions options)

Specified by:

add in class Content

addModernWordArtWatermark

public final void addModernWordArtWatermark(TextWatermark watermark,
                                            SpreadsheetShapeSettings shapeSettings)

addWatermark

public final void addWatermark(Watermark watermark,
                               SpreadsheetShapeSettings shapeSettings,
                               ISpreadsheetWatermarkEffects effects)

addWatermarkAsBackground

public final void addWatermarkAsBackground(Watermark watermark,
                                           int backgroundWidth,
                                           int backgroundHeight)

addWatermarkIntoHeaderFooter

public final void addWatermarkIntoHeaderFooter(Watermark watermark)

decrypt

public final void decrypt()

Decrypts the document.

Specified by:

decrypt in interface IEncryptable

dispose

protected void dispose(boolean disposing)

Releases all resources used by the SpreadsheetContent

Overrides:

dispose in class Content

Parameters:

disposing - True to release both managed and unmanaged resources; false to release only unmanaged resources.

encrypt

public final void encrypt(String password)

Encrypts the content.

Specified by:

encrypt in interface IEncryptable

Parameters:

password - The password that will be required to open the document.

generatePreview

public void generatePreview(PreviewOptions previewOptions)

Specified by:

generatePreview in class Content

getAsposeCellsWorkbook

public final com.aspose.cells.Workbook getAsposeCellsWorkbook()

getDocumentInfo

public IDocumentInfo getDocumentInfo()

Specified by:

getDocumentInfo in class Content

getFileType

public FileType getFileType()

Specified by:

getFileType in class Content

getWorksheets

public final SpreadsheetWorksheetCollection getWorksheets()

Gets the collection of all worksheets of this SpreadsheetContent.

Returns:

The collection of all worksheets of this SpreadsheetContent.

performSave

public void performSave(OutputStream stream)

Specified by:

performSave in class Content

performSave

public void performSave(OutputStream stream,
                        SaveOptions saveOptions)

Specified by:

performSave in class Content

performSave

public void performSave(String filePath)

Specified by:

performSave in class Content

performSave

public void performSave(String filePath,
                        SaveOptions saveOptions)

Specified by:

performSave in class Content