Table of Contents

Class PdfSignatureFormField

Namespace
iText.Forms.Fields
Assembly
itext.forms.dll

An AcroForm field containing signature data.

public class PdfSignatureFormField : PdfFormField
Inheritance
PdfSignatureFormField
Inherited Members

Constructors

PdfSignatureFormField(PdfWidgetAnnotation, PdfDocument)

Creates a signature form field as a parent of a PdfWidgetAnnotation.

protected PdfSignatureFormField(PdfWidgetAnnotation widget, PdfDocument pdfDocument)

Parameters

widget PdfWidgetAnnotation

The widget which will be a kid of the PdfSignatureFormField.

pdfDocument PdfDocument

The PdfDocument instance.

PdfSignatureFormField(PdfDictionary)

Creates a signature form field as a wrapper object around a PdfDictionary.

protected PdfSignatureFormField(PdfDictionary pdfObject)

Parameters

pdfObject PdfDictionary

the dictionary to be wrapped, must have an indirect reference.

Remarks

Creates a signature form field as a wrapper object around a PdfDictionary. This PdfDictionary must be an indirect object.

PdfSignatureFormField(PdfDocument)

Creates a minimal PdfSignatureFormField.

protected PdfSignatureFormField(PdfDocument pdfDocument)

Parameters

pdfDocument PdfDocument

The PdfDocument instance.

Methods

GetFormType()

Returns Sig, the form type for signature form fields.

public override PdfName GetFormType()

Returns

PdfName

the form type, as a PdfName

GetSigFieldLockDictionary()

Gets the PdfSigFieldLock , which contains fields that must be locked if the document is signed.

public virtual PdfSigFieldLock GetSigFieldLockDictionary()

Returns

PdfSigFieldLock

a dictionary containing locked fields.

See Also

SetBackgroundLayer(PdfFormXObject)

Sets the background layer that is present when creating the signature field.

public virtual PdfSignatureFormField SetBackgroundLayer(PdfFormXObject n0)

Parameters

n0 PdfFormXObject

layer xObject.

Returns

PdfSignatureFormField

this same PdfSignatureFormField instance.

SetIgnorePageRotation(bool)

Sets the boolean value which indicates if page rotation should be ignored for the signature appearance.

public virtual PdfSignatureFormField SetIgnorePageRotation(bool ignore)

Parameters

ignore bool

boolean value to set.

Returns

PdfSignatureFormField

this same PdfSignatureFormField instance.

Remarks

Sets the boolean value which indicates if page rotation should be ignored for the signature appearance.

Default value is true.

SetReuseAppearance(bool)

Indicates that the existing appearances needs to be reused as a background.

public virtual PdfSignatureFormField SetReuseAppearance(bool reuseAppearance)

Parameters

reuseAppearance bool

is an appearances reusing flag value to set.

Returns

PdfSignatureFormField

this same PdfSignatureFormField instance.

SetSignatureAppearanceLayer(PdfFormXObject)

Sets the signature appearance layer that contains information about the signature, e.g. the line art for the handwritten signature, the text giving the signer’s name, date, reason, location and so on.

public virtual PdfSignatureFormField SetSignatureAppearanceLayer(PdfFormXObject n2)

Parameters

n2 PdfFormXObject

layer xObject.

Returns

PdfSignatureFormField

this same PdfSignatureFormField instance.

SetValue(PdfObject)

Adds the signature to the signature field.

public virtual PdfSignatureFormField SetValue(PdfObject value)

Parameters

value PdfObject

the signature to be contained in the signature field, or an indirect reference to it

Returns

PdfSignatureFormField

the edited field