WordProcessingWatermarkBaseOptions Leave feedback
On this page
Inheritance: java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.WordProcessingWatermarkOptions
public abstract class WordProcessingWatermarkBaseOptions extends WordProcessingWatermarkOptions
Base class for watermark adding options to a Word document.
| Method | Description |
|---|---|
| isLocked() | Gets a value indicating whether an editing of the shape in Word is forbidden. |
| setLocked(boolean value) | Sets a value indicating whether an editing of the shape in Word is forbidden. |
| getLockType() | Gets the watermark lock type. |
| setLockType(int value) | Sets the watermark lock type. |
| getPassword() | Gets a password used to lock the watermark. |
| setPassword(String value) | Sets a password used to lock the watermark. |
| getName() | Gets the name a shape. |
| setName(String value) | Sets the name a shape. |
| getAlternativeText() | Gets the descriptive (alternative) text that will be associated with a shape. |
| setAlternativeText(String value) | Sets the descriptive (alternative) text that will be associated with a shape. |
| getEffects() | |
| setEffects(IWordProcessingWatermarkEffects value) |
public final boolean isLocked()
Gets a value indicating whether an editing of the shape in Word is forbidden.
Returns: boolean - If the value is true , shape editing will be forbidden. By default, the value is false , the shape can be edited in Word.
public final void setLocked(boolean value)
Sets a value indicating whether an editing of the shape in Word is forbidden.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | If the value is true , shape editing will be forbidden. By default, the value is false , the shape can be edited in Word. |
public final int getLockType()
Gets the watermark lock type.
Returns:
int - The watermark [WordProcessingLockType](../../com.groupdocs.watermark.options/wordprocessinglocktype) lock type.
public final void setLockType(int value)
Sets the watermark lock type.
The value [WordProcessingLockType.AllowOnlyFormFields](../../com.groupdocs.watermark.options/wordprocessinglocktype#AllowOnlyFormFields) can not be used with an object of type [WordProcessingHeaderFooter](../../com.groupdocs.watermark.contents/wordprocessingheaderfooter).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The watermark [WordProcessingLockType](../../com.groupdocs.watermark.options/wordprocessinglocktype) lock type. |
public final String getPassword()
Gets a password used to lock the watermark.
Returns: java.lang.String - A password used to lock the watermark.
public final void setPassword(String value)
Sets a password used to lock the watermark.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | A password used to lock the watermark. |
public final String getName()
Gets the name a shape.
Returns: java.lang.String - The shape name.
public final void setName(String value)
Sets the name a shape.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The shape name. |
public final String getAlternativeText()
Gets the descriptive (alternative) text that will be associated with a shape.
Returns: java.lang.String - The descriptive (alternative) text that will be associated with a shape.
public final void setAlternativeText(String value)
Sets the descriptive (alternative) text that will be associated with a shape.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The descriptive (alternative) text that will be associated with a shape. |
public final IWordProcessingWatermarkEffects getEffects()
Returns: IWordProcessingWatermarkEffects
public final void setEffects(IWordProcessingWatermarkEffects value)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IWordProcessingWatermarkEffects |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.