SpreadsheetWatermarkShapeOptions class

SpreadsheetWatermarkShapeOptions class

Represents options when adding shape watermark to a Spreadsheet worksheet.

The SpreadsheetWatermarkShapeOptions type exposes the following members:

Constructors

Constructor Description
init Initializes a new instance of the SpreadsheetWatermarkShapeOptions class.

Properties

Property Description
effects The effects applied to the watermark, specified as a SpreadsheetImageEffects or SpreadsheetTextEffects instance.
worksheet_index The index of the worksheet to add the watermark to.
alternative_text The descriptive (alternative) text that will be associated with a shape. (inherited from SpreadsheetWatermarkBaseOptions)
is_locked The property indicates whether editing of the shape in Excel is forbidden. (inherited from SpreadsheetWatermarkBaseOptions)
name The name of the shape. (inherited from SpreadsheetWatermarkBaseOptions)

Fields

Field Description
DEFAULT Gets the default value for the class. (inherited from WatermarkOptions)

Example

import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.spreadsheet as gwo_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 36))
    options = gwo_xls.SpreadsheetWatermarkShapeOptions()
    options.worksheet_index = 0
    watermarker.add(watermark, options)
    watermarker.save("spreadsheet.xlsx")

See Also