SpreadsheetWatermarkShapeOptions Leave feedback

Inheritance: java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.SpreadsheetWatermarkOptions, com.groupdocs.watermark.options.SpreadsheetWatermarkBaseOptions

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();

public SpreadsheetWatermarkShapeOptions()

Initializes a new instance of the [SpreadsheetWatermarkShapeOptions](../../com.groupdocs.watermark.options/spreadsheetwatermarkshapeoptions) class.

public final int getWorksheetIndex()

Gets the index of worksheet to add the watermark to.

Returns: int - The index of worksheet to add the watermark to.

-1 means every worksheet.

public final void setWorksheetIndex(int value)

Sets the index of worksheet to add the watermark to.

Parameters:

-1 means every worksheet. |

public final ISpreadsheetWatermarkEffects getEffects()

Gets a value of [SpreadsheetImageEffects](../../com.groupdocs.watermark.options/spreadsheetimageeffects) or [SpreadsheetTextEffects](../../com.groupdocs.watermark.options/spreadsheettexteffects) for effects that should be applied to the watermark.

Returns: ISpreadsheetWatermarkEffects - The [SpreadsheetImageEffects](../../com.groupdocs.watermark.options/spreadsheetimageeffects) or [SpreadsheetTextEffects](../../com.groupdocs.watermark.options/spreadsheettexteffects) for effects that should be applied to the watermark.

public final void setEffects(ISpreadsheetWatermarkEffects value)

Gets or sets a value of [SpreadsheetImageEffects](../../com.groupdocs.watermark.options/spreadsheetimageeffects) or [SpreadsheetTextEffects](../../com.groupdocs.watermark.options/spreadsheettexteffects) for effects that should be applied to the watermark.

Parameters: