public class PdfSignTextOptions extends SignTextOptions implements IOpacity, ITextAlignment
Represents the Text Signature Options for PDF Documents.
Constructor and Description |
---|
PdfSignTextOptions()
Initializes a new instance of the PdfSignTextOptions class with default values.
|
PdfSignTextOptions(String text)
Initializes a new instance of the PdfSignTextOptions class with text.
|
PdfSignTextOptions(String text,
int left,
int top,
int width,
int height)
Initializes a new instance of the PdfSignTextOptions class with text and signature area rectangle.
|
Modifier and Type | Method and Description |
---|---|
Brush |
getBackgroundBrushStyle()
Gets or sets the signature background brush.
|
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.
|
double |
getOpacity()
Gets or sets the signature opacity (value from 0.0 (clear) through 1.0 (opaque)).
|
int |
getSignatureID()
Gets or sets the unique ID of signature.
|
int |
getSignatureImplementation()
Gets or sets the type of text signature implementation.
|
int |
getTextHorizontalAlignment()
Horizontal alignment of text inside a signature.
|
int |
getTextVerticalAlignment()
Vertical alignment of text inside a signature.
|
void |
setBackgroundBrushStyle(Brush value)
Gets or sets the signature background brush.
|
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 |
setOpacity(double value)
Gets or sets the signature opacity (value from 0.0 (clear) through 1.0 (opaque)).
|
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 |
setTextHorizontalAlignment(int value)
Horizontal alignment of text inside a signature.
|
void |
setTextVerticalAlignment(int value)
Vertical alignment of text inside a signature.
|
getBackgroundColor, getBorderColor, getFont, getForeColor, getHeight, getHorizontalAlignment, getImageHelper, getLeft, getLocationMeasureType, getMargin, getMarginMeasureType, getRotationAngle, getSignAllPages, getSizeMeasureType, getStretch, getText, getTop, getVerticalAlignment, getWidth, setBackgroundColor, setBorderColor, setFont, setForeColor, setHeight, setHorizontalAlignment, setLeft, setLocationMeasureType, setMargin, setMarginMeasureType, setRotationAngle, setSignAllPages, setSizeMeasureType, setStretch, setText, setTop, setVerticalAlignment, setWidth, toString
getAppearance, getDocumentPageNumber, getExtensions, getPagesSetup, setAppearance, setDocumentPageNumber, setPagesSetup
public PdfSignTextOptions()
Initializes a new instance of the PdfSignTextOptions class with default values.
public PdfSignTextOptions(String text)
Initializes a new instance of the PdfSignTextOptions class with text.
text
- Signature textpublic PdfSignTextOptions(String text, int left, int top, int width, int height)
Initializes a new instance of the PdfSignTextOptions class with text and signature area rectangle.
text
- Text signature.left
- The x-coordinate of the left edge of this Text Signature.top
- The y-coordinate of the top edge of this Text Signature.width
- The width of Text Signature.height
- The height of Text Signature.public Brush getBackgroundBrushStyle()
Gets or sets the signature background brush. Value by default is null. When property has a value it is used instead BackgroundBrush property. For Stamp implementation LinearGradientBrush (ColorStart) and RadialGradientBrush (ColorInner) are used as SolidBrush. It is not used for Annotation, Sticker, TextToFormField and Watermark implementations.
getBackgroundBrushStyle
in class SignTextOptions
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 PdfTextSignatureImplementation = 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 PdfTextSignatureImplementation = TextToFormField. Value by default is AllTextTypes.
public final double getOpacity()
Gets or sets the signature opacity (value from 0.0 (clear) through 1.0 (opaque)). By default the value is 1.0.
getOpacity
in interface IOpacity
public final int getSignatureID()
Gets or sets the unique ID of signature. It can be used in signature verification options.
public final int getSignatureImplementation()
Gets or sets the type of text signature implementation.
public final int getTextHorizontalAlignment()
Horizontal alignment of text inside a signature.
This feature is supported only for Image and Annotation signature implementations
(see PdfTextSignatureImplementation
SignatureImplementation property).
getTextHorizontalAlignment
in interface ITextAlignment
public final int getTextVerticalAlignment()
Vertical alignment of text inside a signature.
This feature is supported only for Image signature implementation
(see PdfTextSignatureImplementation
SignatureImplementation property).
getTextVerticalAlignment
in interface ITextAlignment
public void setBackgroundBrushStyle(Brush value)
Gets or sets the signature background brush. Value by default is null. When property has a value it is used instead BackgroundBrush property. For Stamp implementation LinearGradientBrush (ColorStart) and RadialGradientBrush (ColorInner) are used as SolidBrush. It is not used for Annotation, Sticker, TextToFormField and Watermark implementations.
setBackgroundBrushStyle
in class SignTextOptions
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 PdfTextSignatureImplementation = 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 PdfTextSignatureImplementation = TextToFormField. Value by default is AllTextTypes.
public final void setOpacity(double value)
Gets or sets the signature opacity (value from 0.0 (clear) through 1.0 (opaque)). By default the value is 1.0.
setOpacity
in interface IOpacity
public final void setSignatureID(int value)
Gets or sets the unique ID of signature. It can be used in signature verification options.
public final void setSignatureImplementation(int value)
Gets or sets the type of text signature implementation.
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 PdfTextSignatureImplementation
SignatureImplementation property).
setTextHorizontalAlignment
in interface ITextAlignment
public final void setTextVerticalAlignment(int value)
Vertical alignment of text inside a signature.
This feature is supported only for Image signature implementation
(see PdfTextSignatureImplementation
SignatureImplementation property).
setTextVerticalAlignment
in interface ITextAlignment
Copyright © 2019. All rights reserved.