com.groupdocs.watermark.options

Class WordProcessingWatermarkBaseOptions

java.lang.Object

com.groupdocs.watermark.options.WatermarkOptions

com.groupdocs.watermark.options.WordProcessingWatermarkOptions

com.groupdocs.watermark.options.WordProcessingWatermarkBaseOptions

Direct Known Subclasses:

WordProcessingWatermarkHeaderFooterOptions, WordProcessingWatermarkPagesOptions, WordProcessingWatermarkSectionOptions

public abstract class WordProcessingWatermarkBaseOptions
extends WordProcessingWatermarkOptions

Base class for watermark adding options to a Word document.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getAlternativeText() Gets the descriptive (alternative) text that will be associated with a shape.
IWordProcessingWatermarkEffects	getEffects()
int	getLockType() Gets the watermark lock type.
String	getName() Gets the name a shape.
String	getPassword() Gets a password used to lock the watermark.
boolean	isLocked() Gets a value indicating whether an editing of the shape in Word is forbidden.
void	setAlternativeText(String value) Sets the descriptive (alternative) text that will be associated with a shape.
void	setEffects(IWordProcessingWatermarkEffects value)
void	setLocked(boolean value) Sets a value indicating whether an editing of the shape in Word is forbidden.
void	setLockType(int value) Sets the watermark lock type.
void	setName(String value) Sets the name a shape.
void	setPassword(String value) Sets a password used to lock the watermark.

Methods inherited from class java.lang.Object

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

Constructor Detail

WordProcessingWatermarkBaseOptions

protected WordProcessingWatermarkBaseOptions()

Initializes a new instance of the WordProcessingWatermarkBaseOptions 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.

getEffects

public final IWordProcessingWatermarkEffects getEffects()

getLockType

public final int getLockType()

Gets the watermark lock type.

Returns:

The watermark WordProcessingLockType lock type.

getName

public final String getName()

Gets the name a shape.

Returns:

The shape name.

getPassword

public final String getPassword()

Gets a password used to lock the watermark.

Returns:

A password used to lock the watermark.

isLocked

public final boolean isLocked()

Gets a value indicating whether an editing of the shape in Word 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 Word.

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.

setEffects

public final void setEffects(IWordProcessingWatermarkEffects value)

setLocked

public final void setLocked(boolean value)

Sets a value indicating whether an editing of the shape in Word 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 Word.

setLockType

public final void setLockType(int value)

Sets the watermark lock type.

The value WordProcessingLockType.AllowOnlyFormFields can not be used with an object of type WordProcessingHeaderFooter.

Parameters:

value - The watermark WordProcessingLockType lock type.

setName

public final void setName(String value)

Sets the name a shape.

Parameters:

value - The shape name.

setPassword

public final void setPassword(String value)

Sets a password used to lock the watermark.

Parameters:

value - A password used to lock the watermark.