com.groupdocs.signature.options.textsignature

Class PdfSignTextOptions

java.lang.Object

com.groupdocs.signature.options.SignOptions

com.groupdocs.signature.options.textsignature.SignTextOptions

com.groupdocs.signature.options.textsignature.PdfSignTextOptions

All Implemented Interfaces:

IAlignment, IOpacity, IRectangle, IRotation

public class PdfSignTextOptions
extends SignTextOptions
implements IOpacity

Represents the Text Signature Options for PDF Documents.

Constructor Summary

Constructors

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.

Method Summary

Methods

Modifier and Type	Method and Description
Brush	getBackgroundBrushStyle() Gets or sets the signature background brush.
Color	getBorderColor() Gets or sets the signature border color.
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.
void	setBackgroundBrushStyle(Brush value) Gets or sets the signature background brush.
void	setBorderColor(Color value) Gets or sets the signature border color.
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.

Methods inherited from class com.groupdocs.signature.options.textsignature.SignTextOptions

getBackgroundColor, getFont, getForeColor, getHeight, getHorizontalAlignment, getImageHelper, getLeft, getLocationMeasureType, getMargin, getMarginMeasureType, getRotationAngle, getSignAllPages, getSizeMeasureType, getStretch, getText, getTop, getVerticalAlignment, getWidth, setBackgroundColor, setFont, setForeColor, setHeight, setHorizontalAlignment, setLeft, setLocationMeasureType, setMargin, setMarginMeasureType, setRotationAngle, setSignAllPages, setSizeMeasureType, setStretch, setText, setTop, setVerticalAlignment, setWidth, toString

Methods inherited from class com.groupdocs.signature.options.SignOptions

getAppearance, getDocumentPageNumber, getExtensions, getPagesSetup, release, setAppearance, setDocumentPageNumber, setPagesSetup, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PdfSignTextOptions

public PdfSignTextOptions()

Initializes a new instance of the PdfSignTextOptions class with default values.

PdfSignTextOptions

public PdfSignTextOptions(String text)

Initializes a new instance of the PdfSignTextOptions class with text.

Parameters:

text - Signature text

PdfSignTextOptions

public 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.

Parameters:

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.

Method Detail

getBackgroundBrushStyle

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.

Overrides:

getBackgroundBrushStyle in class SignTextOptions

getBorderColor

public Color getBorderColor()

Gets or sets the signature border color.

Overrides:

getBorderColor in class SignTextOptions

getFormTextFieldTitle

public 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.

getFormTextFieldType

public 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.

getOpacity

public double getOpacity()

Gets or sets the signature opacity (value from 0.0 (clear) through 1.0 (opaque)). By default the value is 1.0.

Specified by:

getOpacity in interface IOpacity

getSignatureID

public int getSignatureID()

Gets or sets the unique ID of signature. It can be used in signature verification options.

getSignatureImplementation

public int getSignatureImplementation()

Gets or sets the type of text signature implementation.

setBackgroundBrushStyle

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.

Overrides:

setBackgroundBrushStyle in class SignTextOptions

setBorderColor

public void setBorderColor(Color value)

Gets or sets the signature border color.

Overrides:

setBorderColor in class SignTextOptions

setFormTextFieldTitle

public 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.

setFormTextFieldType

public 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.

setOpacity

public 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.

Specified by:

setOpacity in interface IOpacity

setSignatureID

public void setSignatureID(int value)

Gets or sets the unique ID of signature. It can be used in signature verification options.

setSignatureImplementation

public void setSignatureImplementation(int value)

Gets or sets the type of text signature implementation.