public final class WordProcessingShapeSettings extends OfficeShapeSettings
Represents settings that can be applied to a shape watermark for a Word document.
Constructor and Description |
---|
WordProcessingShapeSettings()
Initializes a new instance of the
class. |
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.
|
getAlternativeText, getName, setAlternativeText, setName
public WordProcessingShapeSettings()
WordProcessingShapeSettings
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()
WordProcessingLockType
.public final void setLockType(int value)
Value
can not be used with
an object of type WordProcessingLockType.AllowOnlyFormFields
.WordProcessingHeaderFooter
value
- The watermark lock type of WordProcessingLockType
.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 int[] getPageNumbers()
Gets the page numbers to add the watermark.
null
, the watermark is added to all pages.
public final void setPageNumbers(int[] value)
Sets the page numbers to add the watermark.
value
- The page numbers to add the watermark.null
, the watermark is added to all pages.