public class TextSignOptions extends SignOptions implements IRectangle, IAlignment, IRotation, ITransparency
Represents the Text signature options.
| Modifier and Type | Field and Description |
|---|---|
static double |
DEFAULT_TRANSPARENCY |
| Constructor and Description |
|---|
TextSignOptions()
Initializes a new instance of the SignTextOptions class with default values.
|
TextSignOptions(String text)
Initializes a new instance of the SignTextOptions class with text.
|
| Modifier and Type | Method and Description |
|---|---|
Background |
getBackground()
Gets or sets the signature background settings.
|
Border |
getBorder()
Specify border settings
|
SignatureFont |
getFont()
Gets or sets the font of signature.
|
Color |
getForeColor()
Gets or sets the fore color of signature.
|
String |
getFormTextFieldTitle()
Gets or sets the title of text form field to put text signature into it.
|
int |
getFormTextFieldType()
Gets or sets the type of form field to put text signature into it.
|
int |
getHeight()
Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see
MeasureType SizeMeasureType property). |
int |
getHorizontalAlignment()
Horizontal alignment of signature on document page.
|
int |
getLeft()
Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see
MeasureType LocationMeasureType property). |
int |
getLocationMeasureType()
Measure type (pixels, percents or millimeters) for Left and Top properties.
|
Padding |
getMargin()
Gets or sets the space between Sign and Document edges.
|
int |
getMarginMeasureType()
Gets or sets the measure type (pixels, percents or millimeters) for Margin.
|
boolean |
getNative()
Gets or sets the native attribute.
|
int |
getRotationAngle()
Rotation angle of signature on document page (clockwise).
|
int |
getShapePosition()
Defines where shape should be presented in the document layout
|
int |
getShapeType()
Gets or sets the type of shape to put text.
|
int |
getSignatureID()
Gets or sets the unique ID of signature.
|
int |
getSignatureImplementation()
Gets or sets the type of text signature implementation.
|
int |
getSizeMeasureType()
Measure type (pixels, percents or millimeters) for Width and Height properties.
|
int |
getStretch()
Stretch mode on Document Page.
|
String |
getText()
Gets or sets the text of signature.
|
int |
getTextHorizontalAlignment()
Horizontal alignment of text inside a signature.
|
int |
getTextVerticalAlignment()
Vertical alignment of text inside a signature.
|
int |
getTop()
Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see
MeasureType LocationMeasureType property). |
double |
getTransparency()
Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)).
|
int |
getVerticalAlignment()
Vertical alignment of signature on document page.
|
int |
getWidth()
Width of Signature on Document Page in Measure values
(pixels, percents or millimeters see
MeasureType SizeMeasureType property). |
void |
setBackground(Background value)
Gets or sets the signature background settings.
|
void |
setBorder(Border value)
Specify border settings
|
void |
setFont(SignatureFont value)
Gets or sets the font of signature.
|
void |
setForeColor(Color value)
Gets or sets the fore color of signature.
|
void |
setFormTextFieldTitle(String value)
Gets or sets the title of text form field to put text signature into it.
|
void |
setFormTextFieldType(int value)
Gets or sets the type of form field to put text signature into it.
|
void |
setHeight(int value)
Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see
MeasureType SizeMeasureType property). |
void |
setHorizontalAlignment(int value)
Horizontal alignment of signature on document page.
|
void |
setLeft(int value)
Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see
MeasureType LocationMeasureType property). |
void |
setLocationMeasureType(int value)
Measure type (pixels, percents or millimeters) for Left and Top properties.
|
void |
setMargin(Padding value)
Gets or sets the space between Sign and Document edges.
|
void |
setMarginMeasureType(int value)
Gets or sets the measure type (pixels, percents or millimeters) for Margin.
|
void |
setNative(boolean value)
Gets or sets the native attribute.
|
void |
setRotationAngle(int value)
Rotation angle of signature on document page (clockwise).
|
void |
setShapePosition(int value)
Defines where shape should be presented in the document layout
|
void |
setShapeType(int value)
Gets or sets the type of shape to put text.
|
void |
setSignatureID(int value)
Gets or sets the unique ID of signature.
|
void |
setSignatureImplementation(int value)
Gets or sets the type of text signature implementation.
|
void |
setSizeMeasureType(int value)
Measure type (pixels, percents or millimeters) for Width and Height properties.
|
void |
setStretch(int value)
Stretch mode on Document Page.
|
void |
setText(String value)
Gets or sets the text of signature.
|
void |
setTextHorizontalAlignment(int value)
Horizontal alignment of text inside a signature.
|
void |
setTextVerticalAlignment(int value)
Vertical alignment of text inside a signature.
|
void |
setTop(int value)
Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see
MeasureType LocationMeasureType property). |
void |
setTransparency(double value)
Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)).
|
void |
setVerticalAlignment(int value)
Vertical alignment of signature on document page.
|
void |
setWidth(int value)
Width of Signature on Document Page in Measure values
(pixels, percents or millimeters see
MeasureType SizeMeasureType property). |
String |
toString()
Override string conversion.
|
void |
validate()
Internal method to validate the options parameters.
|
addSignature, getAllPages, getAppearance, getDocumentType, getExtensions, getPageNumber, getPagesSetup, getSignatureType, getZOrder, setAllPages, setAppearance, setDocumentType, setExtensions, setPageNumber, setPagesSetup, setZOrderpublic static final double DEFAULT_TRANSPARENCY
public TextSignOptions()
Initializes a new instance of the SignTextOptions class with default values.
public TextSignOptions(String text)
Initializes a new instance of the SignTextOptions class with text.
text - Signature text.public final Background getBackground()
Gets or sets the signature background settings.
public final Border getBorder()
Specify border settings
public final SignatureFont getFont()
Gets or sets the font of signature.
public Color getForeColor()
Gets or sets the fore color of signature.
public final String getFormTextFieldTitle()
Gets or sets the title of text form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField.
public final int getFormTextFieldType()
Gets or sets the type of form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. Value by default is AllTextTypes.
public final int getHeight()
Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).
getHeight in interface IRectanglepublic final int getHorizontalAlignment()
Horizontal alignment of signature on document page.
getHorizontalAlignment in interface IAlignmentpublic final int getLeft()
Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
(works if horizontal alignment is not specified).
getLeft in interface IRectanglepublic int getLocationMeasureType()
Measure type (pixels, percents or millimeters) for Left and Top properties.
getLocationMeasureType in interface IRectanglepublic Padding getMargin()
Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).
getMargin in interface IAlignmentpublic int getMarginMeasureType()
Gets or sets the measure type (pixels, percents or millimeters) for Margin.
getMarginMeasureType in interface IAlignmentpublic final boolean getNative()
Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example.
public final int getRotationAngle()
Rotation angle of signature on document page (clockwise).
getRotationAngle in interface IRotationpublic final int getShapePosition()
Defines where shape should be presented in the document layout
public final int getShapeType()
Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle.
public final int getSignatureID()
Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only
public final int getSignatureImplementation()
Gets or sets the type of text signature implementation.
public int getSizeMeasureType()
Measure type (pixels, percents or millimeters) for Width and Height properties.
getSizeMeasureType in interface IRectanglepublic final int getStretch()
Stretch mode on Document Page.
getStretch in interface IRectanglepublic final String getText()
Gets or sets the text of signature.
public final int getTextHorizontalAlignment()
Horizontal alignment of text inside a signature.
This feature is supported only for Image and Annotation signature implementations
(see TextSignatureImplementation SignatureImplementation property).
public final int getTextVerticalAlignment()
Vertical alignment of text inside a signature.
This feature is supported only for Image signature implementation
(see TextSignatureImplementation SignatureImplementation property).
public final int getTop()
Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
(works if vertical alignment is not specified).
getTop in interface IRectanglepublic final double getTransparency()
Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).
getTransparency in interface ITransparencypublic final int getVerticalAlignment()
Vertical alignment of signature on document page.
getVerticalAlignment in interface IAlignmentpublic final int getWidth()
Width of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).
getWidth in interface IRectanglepublic final void setBackground(Background value)
Gets or sets the signature background settings.
public final void setBorder(Border value)
Specify border settings
public final void setFont(SignatureFont value)
Gets or sets the font of signature.
public void setForeColor(Color value)
Gets or sets the fore color of signature.
public final void setFormTextFieldTitle(String value)
Gets or sets the title of text form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField.
public final void setFormTextFieldType(int value)
Gets or sets the type of form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. Value by default is AllTextTypes.
public final void setHeight(int value)
Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).
setHeight in interface IRectanglepublic final void setHorizontalAlignment(int value)
Horizontal alignment of signature on document page.
setHorizontalAlignment in interface IAlignmentpublic final void setLeft(int value)
Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
(works if horizontal alignment is not specified).
setLeft in interface IRectanglepublic void setLocationMeasureType(int value)
Measure type (pixels, percents or millimeters) for Left and Top properties.
setLocationMeasureType in interface IRectanglepublic void setMargin(Padding value)
Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).
setMargin in interface IAlignmentpublic void setMarginMeasureType(int value)
Gets or sets the measure type (pixels, percents or millimeters) for Margin.
setMarginMeasureType in interface IAlignmentpublic final void setNative(boolean value)
Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example.
public final void setRotationAngle(int value)
Rotation angle of signature on document page (clockwise).
setRotationAngle in interface IRotationpublic final void setShapePosition(int value)
Defines where shape should be presented in the document layout
public final void setShapeType(int value)
Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle.
public final void setSignatureID(int value)
Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only
public final void setSignatureImplementation(int value)
Gets or sets the type of text signature implementation.
public void setSizeMeasureType(int value)
Measure type (pixels, percents or millimeters) for Width and Height properties.
setSizeMeasureType in interface IRectanglepublic final void setStretch(int value)
Stretch mode on Document Page.
setStretch in interface IRectanglepublic final void setText(String value)
Gets or sets the text of signature.
public final void setTextHorizontalAlignment(int value)
Horizontal alignment of text inside a signature.
This feature is supported only for Image and Annotation signature implementations
(see TextSignatureImplementation SignatureImplementation property).
public final void setTextVerticalAlignment(int value)
Vertical alignment of text inside a signature.
This feature is supported only for Image signature implementation
(see TextSignatureImplementation SignatureImplementation property).
public final void setTop(int value)
Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
(works if vertical alignment is not specified).
setTop in interface IRectanglepublic final void setTransparency(double value)
Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).
setTransparency in interface ITransparencypublic final void setVerticalAlignment(int value)
Vertical alignment of signature on document page.
setVerticalAlignment in interface IAlignmentpublic final void setWidth(int value)
Width of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).
setWidth in interface IRectanglepublic String toString()
Override string conversion.
toString in class SignOptionspublic void validate()
throws Exception
Internal method to validate the options parameters.
validate in class SignOptionsExceptionCopyright © 2024. All rights reserved.