public abstract class WordProcessingWatermarkBaseOptions extends WordProcessingWatermarkOptions
Base class for watermark adding options to a Word document.
Modifier | Constructor and Description |
---|---|
protected |
WordProcessingWatermarkBaseOptions()
Initializes a new instance of the
WordProcessingWatermarkBaseOptions class. |
Modifier and Type | Method and Description |
---|---|
String |
getAlternativeText()
Gets the descriptive (alternative) text that will be associated with a shape.
|
IWordProcessingWatermarkEffects |
getEffects()
Gets or sets a value of
WordProcessingImageEffects or
WordProcessingTextEffects for effects that should be applied to the watermark. |
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)
Gets or sets a value of
WordProcessingImageEffects or
WordProcessingTextEffects for effects that should be applied to the watermark. |
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.
|
protected WordProcessingWatermarkBaseOptions()
Initializes a new instance of the WordProcessingWatermarkBaseOptions
class.
public final boolean isLocked()
Gets a value indicating whether an editing of the shape in Word is forbidden.
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.
value
- 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.
Value WordProcessingLockType.AllowOnlyFormFields
can not be used with an object of type WordProcessingHeaderFooter
.
public final void setLockType(int value)
Sets the watermark lock type.
Value WordProcessingLockType.AllowOnlyFormFields
can not be used with an object of type WordProcessingHeaderFooter
.
value
- The watermark lock type.public final String getPassword()
Gets a password used to lock the watermark.
public final void setPassword(String value)
Sets a password used to lock the watermark.
value
- A password used to lock the watermark.public final String getName()
Gets the name a shape.
public final void setName(String value)
Sets the name a shape.
value
- The shape name.public final String getAlternativeText()
Gets 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.
value
- The descriptive (alternative) text that will be associated with a shape.public final IWordProcessingWatermarkEffects getEffects()
Gets or sets a value of WordProcessingImageEffects
or
WordProcessingTextEffects
for effects that should be applied to the watermark.
public final void setEffects(IWordProcessingWatermarkEffects value)
Gets or sets a value of WordProcessingImageEffects
or
WordProcessingTextEffects
for effects that should be applied to the watermark.
Copyright © 2020. All rights reserved.