@Deprecated public class WordsShapeSettings extends OfficeShapeSettings
Represents settings that can be applied to a shape watermark for a Word document.
Constructor and Description |
---|
WordsShapeSettings()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
int |
getLockType()
Deprecated.
Gets the watermark lock type.
|
int[] |
getPageNumbers()
Deprecated.
Gets the page numbers to add the watermark.
|
String |
getPassword()
Deprecated.
Gets a password used to lock the watermark.
|
boolean |
isLocked()
Deprecated.
Gets a value indicating whether an editing of the shape in Word is forbidden.
|
void |
setLocked(boolean value)
Deprecated.
Sets a value indicating whether an editing of the shape in Word is forbidden.
|
void |
setLockType(int value)
Deprecated.
Sets the watermark lock type.
|
void |
setPageNumbers(int[] value)
Deprecated.
Sets the page numbers to add the watermark.
|
void |
setPassword(String value)
Deprecated.
Sets a password used to lock the watermark.
|
getAlternativeText, getName, setAlternativeText, setName
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 WordsLockType.AllowOnlyFormFields
can not be used with an object of type WordsHeaderFooter
.
public final void setLockType(int value)
Sets the watermark lock type.
Value WordsLockType.AllowOnlyFormFields
can not be used with an object of type WordsHeaderFooter
.
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 int[] getPageNumbers()
Gets 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.
public final void setPageNumbers(int[] value)
Sets 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.
value
- The page numbers to add the watermark.