com.groupdocs.watermark.options

Class WordProcessingShapeSettings

java.lang.Object

com.groupdocs.watermark.contents.OfficeShapeSettings

com.groupdocs.watermark.options.WordProcessingShapeSettings

All Implemented Interfaces:

IDocumentSpecificSettings

public final class WordProcessingShapeSettings
extends OfficeShapeSettings

Represents settings that can be applied to a shape watermark for a Word document.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getLockType() Gets the watermark lock type.
int[]	getPageNumbers() Gets the page numbers to add the watermark.
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	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	setPageNumbers(int[] value) Sets the page numbers to add the watermark.
void	setPassword(String value) Sets a password used to lock the watermark.

Methods inherited from class com.groupdocs.watermark.contents.OfficeShapeSettings

getAlternativeText, getName, setAlternativeText, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

WordProcessingShapeSettings

public WordProcessingShapeSettings()

Initializes a new instance of the WordProcessingShapeSettings class.

Method Detail

getLockType

public final int getLockType()

Gets the watermark lock type.

Returns:

The watermark lock type of WordProcessingLockType.

getPageNumbers

public final int[] getPageNumbers()

Gets the page numbers to add the watermark.

Returns:

The page numbers to add the watermark.

All numbers must be greater than or equal to 1. This property is only used when adding the watermark to a document. If this value is null, the watermark is added to all pages.

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.

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.

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

Parameters:

value - The watermark lock type of WordProcessingLockType.

setPageNumbers

public final void setPageNumbers(int[] value)

Sets the page numbers to add the watermark.

Parameters:

value - The page numbers to add the watermark.

All numbers must be greater than or equal to 1. This property is only used when adding the watermark to a document. If this value is null, the watermark is added to all pages.

setPassword

public final void setPassword(String value)

Sets a password used to lock the watermark.

Parameters:

value - A password used to lock the watermark.