com.groupdocs.watermark.options

Class SpreadsheetWatermarkBaseOptions

java.lang.Object

com.groupdocs.watermark.options.WatermarkOptions

com.groupdocs.watermark.options.SpreadsheetWatermarkOptions

com.groupdocs.watermark.options.SpreadsheetWatermarkBaseOptions

Direct Known Subclasses:

SpreadsheetWatermarkModernWordArtOptions, SpreadsheetWatermarkShapeOptions

public abstract class SpreadsheetWatermarkBaseOptions
extends SpreadsheetWatermarkOptions

Base class for watermark adding options to a Spreadsheet document.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpreadsheetWatermarkBaseOptions() Initializes a new instance of the SpreadsheetWatermarkBaseOptions class.

Method Summary

Modifier and Type	Method and Description
String	getAlternativeText() Gets the descriptive (alternative) text that will be associated with a shape.
String	getName() Gets the name a shape.
boolean	isLocked() Gets a value indicating whether an editing of the shape in Excel is forbidden.
void	setAlternativeText(String value) Sets the descriptive (alternative) text that will be associated with a shape.
void	setLocked(boolean value) Sets a value indicating whether an editing of the shape in Excel is forbidden.
void	setName(String value) Sets the name a shape.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpreadsheetWatermarkBaseOptions

protected SpreadsheetWatermarkBaseOptions()

Initializes a new instance of the SpreadsheetWatermarkBaseOptions class.

Method Detail

getAlternativeText

public final String getAlternativeText()

Gets the descriptive (alternative) text that will be associated with a shape.

Returns:

The descriptive (alternative) text that will be associated with a shape.

getName

public final String getName()

Gets the name a shape.

Returns:

The shape name.

isLocked

public final boolean isLocked()

Gets a value indicating whether an editing of the shape in Excel is forbidden.

Returns:

If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in Excel.

setAlternativeText

public final void setAlternativeText(String value)

Sets the descriptive (alternative) text that will be associated with a shape.

Parameters:

value - The descriptive (alternative) text that will be associated with a shape.

setLocked

public final void setLocked(boolean value)

Sets a value indicating whether an editing of the shape in Excel is forbidden.

Parameters:

value - If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in Excel.

setName

public final void setName(String value)

Sets the name a shape.

Parameters:

value - The shape name.