com.groupdocs.watermark.options

Class SpreadsheetWatermarkShapeOptions

java.lang.Object

com.groupdocs.watermark.options.WatermarkOptions

com.groupdocs.watermark.options.SpreadsheetWatermarkOptions

com.groupdocs.watermark.options.SpreadsheetWatermarkBaseOptions

com.groupdocs.watermark.options.SpreadsheetWatermarkShapeOptions

public final class SpreadsheetWatermarkShapeOptions
extends SpreadsheetWatermarkBaseOptions

Represents options when adding shape watermark to a Spreadsheet worksheet.

Learn more:

• Add watermarks to spreadsheet documents

The following example demonstrates how to add a watermark to a particular worksheet of an Excel document.

   SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
   Watermarker watermarker = new Watermarker("D:\\test.xls", loadOptions);

   TextWatermark watermark = new TextWatermark("Test", new Font("Arial", 14));

   SpreadsheetWatermarkShapeOptions options = new SpreadsheetWatermarkShapeOptions();
   options.setWorksheetIndex(0);
   
   watermarker.save("D:\\watermarked_test.xlsx");
   watermarker.close();
 

Constructor Summary

Constructors

Constructor and Description
SpreadsheetWatermarkShapeOptions() Initializes a new instance of the SpreadsheetWatermarkShapeOptions class.

Method Summary

Modifier and Type	Method and Description
ISpreadsheetWatermarkEffects	getEffects() Gets a value of SpreadsheetImageEffects or SpreadsheetTextEffects for effects that should be applied to the watermark.
int	getWorksheetIndex() Gets the index of worksheet to add the watermark to.
void	setEffects(ISpreadsheetWatermarkEffects value) Gets or sets a value of SpreadsheetImageEffects or SpreadsheetTextEffects for effects that should be applied to the watermark.
void	setWorksheetIndex(int value) Sets the index of worksheet to add the watermark to.

Methods inherited from class com.groupdocs.watermark.options.SpreadsheetWatermarkBaseOptions

getAlternativeText, getName, isLocked, setAlternativeText, setLocked, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

SpreadsheetWatermarkShapeOptions

public SpreadsheetWatermarkShapeOptions()

Initializes a new instance of the SpreadsheetWatermarkShapeOptions class.

Method Detail

getEffects

public final ISpreadsheetWatermarkEffects getEffects()

Gets a value of SpreadsheetImageEffects or SpreadsheetTextEffects for effects that should be applied to the watermark.

Returns:

The SpreadsheetImageEffects or SpreadsheetTextEffects for effects that should be applied to the watermark.

getWorksheetIndex

public final int getWorksheetIndex()

Gets the index of worksheet to add the watermark to.

Returns:

The index of worksheet to add the watermark to.

-1 means every worksheet.

setEffects

public final void setEffects(ISpreadsheetWatermarkEffects value)

Gets or sets a value of SpreadsheetImageEffects or SpreadsheetTextEffects for effects that should be applied to the watermark.

Parameters:

value - The SpreadsheetImageEffects or SpreadsheetTextEffects for effects that should be applied to the watermark.

setWorksheetIndex

public final void setWorksheetIndex(int value)

Sets the index of worksheet to add the watermark to.

Parameters:

value - The index of worksheet to add the watermark to.

-1 means every worksheet.