Properties to be used in signing operations. More...

Public Member Functions
	SignerProperties ()
	Create instance of SignerProperties. More...

virtual DateTime	GetClaimedSignDate ()
	Gets the signature date. More...

virtual iText.Signatures.SignerProperties	SetClaimedSignDate (DateTime signDate)
	Sets the signature date. More...

virtual iText.Signatures.SignerProperties	SetSignatureAppearance (SignatureFieldAppearance appearance)
	Sets the signature field layout element to customize the appearance of the signature. More...

virtual SignatureFieldAppearance	GetSignatureAppearance ()
	Gets signature field appearance object representing the appearance of the signature. More...

virtual AccessPermissions	GetCertificationLevel ()
	Returns the document's certification level. More...

virtual iText.Signatures.SignerProperties	SetCertificationLevel (AccessPermissions accessPermissions)
	Sets the document's certification level. More...

virtual String	GetFieldName ()
	Gets the field name. More...

virtual iText.Signatures.SignerProperties	SetFieldName (String fieldName)
	Sets the name indicating the field to be signed. More...

virtual int	GetPageNumber ()
	Provides the page number of the signature field which this signature appearance is associated with. More...

virtual iText.Signatures.SignerProperties	SetPageNumber (int pageNumber)
	Sets the page number of the signature field which this signature appearance is associated with. More...

virtual Rectangle	GetPageRect ()
	Provides the rectangle that represent the position and dimension of the signature field in the page. More...

virtual iText.Signatures.SignerProperties	SetPageRect (Rectangle pageRect)
	Sets the rectangle that represent the position and dimension of the signature field in the page. More...

virtual PdfSigFieldLock	GetFieldLockDict ()
	Getter for the field lock dictionary. More...

virtual iText.Signatures.SignerProperties	SetFieldLockDict (PdfSigFieldLock fieldLock)
	Setter for the field lock dictionary. More...

virtual String	GetSignatureCreator ()
	Returns the signature creator. More...

virtual iText.Signatures.SignerProperties	SetSignatureCreator (String signatureCreator)
	Sets the name of the application used to create the signature. More...

virtual String	GetContact ()
	Returns the signing contact. More...

virtual iText.Signatures.SignerProperties	SetContact (String contact)
	Sets the signing contact. More...

virtual String	GetReason ()
	Returns the signing reason. More...

virtual iText.Signatures.SignerProperties	SetReason (String reason)
	Sets the signing reason. More...

virtual String	GetLocation ()
	Returns the signing location. More...

virtual iText.Signatures.SignerProperties	SetLocation (String location)
	Sets the signing location. More...

Static Public Attributes
const String	IGNORED_ID = ""
	A placeholder string used as a parameter when creating a iText.Forms.Form.Element.SignatureFieldAppearance instance for signing operations via SetSignatureAppearance(iText.Forms.Form.Element.SignatureFieldAppearance). More...

Detailed Description

Properties to be used in signing operations.

Constructor & Destructor Documentation

◆ SignerProperties()

iText.Signatures.SignerProperties.SignerProperties ( )

inline

Create instance of SignerProperties.

Member Function Documentation

◆ GetCertificationLevel()

virtual AccessPermissions iText.Signatures.SignerProperties.GetCertificationLevel ( )

inlinevirtual

Returns the document's certification level.

Returns the document's certification level. For possible values see AccessPermissions.

Returns

AccessPermissions enum which specifies which certification level shall be used

◆ GetClaimedSignDate()

virtual DateTime iText.Signatures.SignerProperties.GetClaimedSignDate ( )

inlinevirtual

Gets the signature date.

Returns: calendar set to the signature date

◆ GetContact()

virtual String iText.Signatures.SignerProperties.GetContact ( )

inlinevirtual

Returns the signing contact.

Returns: the signing contact

◆ GetFieldLockDict()

virtual PdfSigFieldLock iText.Signatures.SignerProperties.GetFieldLockDict ( )

inlinevirtual

Getter for the field lock dictionary.

Returns: field lock dictionary

◆ GetFieldName()

virtual String iText.Signatures.SignerProperties.GetFieldName ( )

inlinevirtual

Gets the field name.

Returns: the field name

◆ GetLocation()

virtual String iText.Signatures.SignerProperties.GetLocation ( )

inlinevirtual

Returns the signing location.

Returns: the signing location

◆ GetPageNumber()

virtual int iText.Signatures.SignerProperties.GetPageNumber ( )

inlinevirtual

Provides the page number of the signature field which this signature appearance is associated with.

Returns: the page number of the signature field which this signature appearance is associated with

◆ GetPageRect()

virtual Rectangle iText.Signatures.SignerProperties.GetPageRect ( )

inlinevirtual

Provides the rectangle that represent the position and dimension of the signature field in the page.

Returns: the rectangle that represent the position and dimension of the signature field in the page

◆ GetReason()

virtual String iText.Signatures.SignerProperties.GetReason ( )

inlinevirtual

Returns the signing reason.

Returns: the signing reason

◆ GetSignatureAppearance()

virtual SignatureFieldAppearance iText.Signatures.SignerProperties.GetSignatureAppearance ( )

inlinevirtual

Gets signature field appearance object representing the appearance of the signature.

To customize the signature appearance, create new iText.Forms.Form.Element.SignatureFieldAppearance object and set it using SetSignatureAppearance(iText.Forms.Form.Element.SignatureFieldAppearance).

Returns

iText.Forms.Form.Element.SignatureFieldAppearance object representing signature appearance

◆ GetSignatureCreator()

virtual String iText.Signatures.SignerProperties.GetSignatureCreator ( )

inlinevirtual

Returns the signature creator.

Returns: the signature creator

◆ SetCertificationLevel()

virtual iText.Signatures.SignerProperties iText.Signatures.SignerProperties.SetCertificationLevel ( AccessPermissions accessPermissions )

inlinevirtual

Sets the document's certification level.

Parameters

accessPermissions

AccessPermissions enum which specifies which certification level shall be used

Returns: this instance to support fluent interface

◆ SetClaimedSignDate()

virtual iText.Signatures.SignerProperties iText.Signatures.SignerProperties.SetClaimedSignDate ( DateTime signDate )

inlinevirtual

Sets the signature date.

Parameters

signDate the signature date

Returns: this instance to support fluent interface

◆ SetContact()

virtual iText.Signatures.SignerProperties iText.Signatures.SignerProperties.SetContact ( String contact )

inlinevirtual

Sets the signing contact.

Parameters

contact a new signing contact

Returns: this instance to support fluent interface

◆ SetFieldLockDict()

virtual iText.Signatures.SignerProperties iText.Signatures.SignerProperties.SetFieldLockDict ( PdfSigFieldLock fieldLock )

inlinevirtual

Setter for the field lock dictionary.

Be aware: if a signature is created on an existing signature field, then its /Lock dictionary takes the precedence (if it exists).

Parameters

fieldLock field lock dictionary

Returns: this instance to support fluent interface

◆ SetFieldName()

virtual iText.Signatures.SignerProperties iText.Signatures.SignerProperties.SetFieldName ( String fieldName )

inlinevirtual

Sets the name indicating the field to be signed.

Sets the name indicating the field to be signed. The field can already be presented in the document but shall not be signed. If the field is not presented in the document, it will be created.

Note that ID specified for iText.Forms.Form.Element.SignatureFieldAppearance set by SetSignatureAppearance(iText.Forms.Form.Element.SignatureFieldAppearance) will be ignored and won't override the field name.

Parameters

fieldName the name indicating the field to be signed

Returns: this instance to support fluent interface

◆ SetLocation()

virtual iText.Signatures.SignerProperties iText.Signatures.SignerProperties.SetLocation ( String location )

inlinevirtual

Sets the signing location.

Parameters

location a new signing location

Returns: this instance to support fluent interface

◆ SetPageNumber()

virtual iText.Signatures.SignerProperties iText.Signatures.SignerProperties.SetPageNumber ( int pageNumber )

inlinevirtual

Sets the page number of the signature field which this signature appearance is associated with.

Parameters

pageNumber the page number of the signature field which this signature appearance is associated with

Returns: this instance to support fluent interface

◆ SetPageRect()

virtual iText.Signatures.SignerProperties iText.Signatures.SignerProperties.SetPageRect ( Rectangle pageRect )

inlinevirtual

Sets the rectangle that represent the position and dimension of the signature field in the page.

Parameters

pageRect the rectangle that represents the position and dimension of the signature field in the page

Returns: this instance to support fluent interface

◆ SetReason()

virtual iText.Signatures.SignerProperties iText.Signatures.SignerProperties.SetReason ( String reason )

inlinevirtual

Sets the signing reason.

Parameters

reason a new signing reason

Returns: this instance to support fluent interface

◆ SetSignatureAppearance()

virtual iText.Signatures.SignerProperties iText.Signatures.SignerProperties.SetSignatureAppearance ( SignatureFieldAppearance appearance )

inlinevirtual

Sets the signature field layout element to customize the appearance of the signature.

The ID parameter of iText.Forms.Form.Element.SignatureFieldAppearance.SignatureFieldAppearance(System.String) is ignored in signing contexts, as the actual form field name is set via SetFieldName(System.String) or generated automatically by PdfSigner.GetNewSigFieldName() . So IGNORED_ID could be used as a placeholder when creating a iText.Forms.Form.Element.SignatureFieldAppearance instance for this method.

Note that if iText.Forms.Fields.Properties.SignedAppearanceText was set as the content (or part of the content) for iText.Forms.Form.Element.SignatureFieldAppearance object, PdfSigner properties such as signing date, reason, location and signer name could be set automatically.

In case you create new signature field (either using SetFieldName(System.String) with the name that doesn't exist in the document or do not specifying it at all) then the signature is invisible by default. Use SetPageRect(iText.Kernel.Geom.Rectangle) and SetPageNumber(int) to provide the rectangle that represent the position and dimension of the signature field in the specified page.

It is possible to set other appearance related properties such as iText.Forms.Fields.PdfSignatureFormField.SetReuseAppearance(bool) , iText.Forms.Fields.PdfSignatureFormField.SetBackgroundLayer(iText.Kernel.Pdf.Xobject.PdfFormXObject) (n0 layer) and iText.Forms.Fields.PdfSignatureFormField.SetSignatureAppearanceLayer(iText.Kernel.Pdf.Xobject.PdfFormXObject) (n2 layer) for the signature field using PdfSigner.GetSignatureField() . Page, rectangle and other properties could be also set up via SignerProperties.

Parameters

appearance the iText.Forms.Form.Element.SignatureFieldAppearance layout element representing signature appearance

Returns: this instance to support fluent interface

◆ SetSignatureCreator()

virtual iText.Signatures.SignerProperties iText.Signatures.SignerProperties.SetSignatureCreator ( String signatureCreator )

inlinevirtual

Sets the name of the application used to create the signature.

Parameters

signatureCreator A new name of the application signing a document.

Returns: this instance to support fluent interface.

Member Data Documentation

◆ IGNORED_ID

const String iText.Signatures.SignerProperties.IGNORED_ID = ""

static

A placeholder string used as a parameter when creating a iText.Forms.Form.Element.SignatureFieldAppearance instance for signing operations via SetSignatureAppearance(iText.Forms.Form.Element.SignatureFieldAppearance).

The ID parameter of iText.Forms.Form.Element.SignatureFieldAppearance.SignatureFieldAppearance(System.String) is ignored in signing contexts, as the actual form field name is set via SetFieldName(System.String) or generated automatically by PdfSigner.GetNewSigFieldName().

This same constructor serves a dual purpose: when used via the layout module for creating new interactive signature form fields (without embedding an actual signature), the ID parameter serves as the form field name. However, when used for complete signature creation (e.g., via PdfSigner ), the ID parameter is ignored.

The "IGNORED" in the constant name emphasizes that this parameter is intentionally ignored in signing contexts.

See also: SetSignatureAppearance(iText.Forms.Form.Element.SignatureFieldAppearance)

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SignerProperties()

Member Function Documentation

◆ GetCertificationLevel()

◆ GetClaimedSignDate()

◆ GetContact()

◆ GetFieldLockDict()

◆ GetFieldName()

◆ GetLocation()

◆ GetPageNumber()

◆ GetPageRect()

◆ GetReason()

◆ GetSignatureAppearance()

◆ GetSignatureCreator()

◆ SetCertificationLevel()

◆ SetClaimedSignDate()

◆ SetContact()

◆ SetFieldLockDict()

◆ SetFieldName()

◆ SetLocation()

◆ SetPageNumber()

◆ SetPageRect()

◆ SetReason()

◆ SetSignatureAppearance()

◆ SetSignatureCreator()

Member Data Documentation

◆ IGNORED_ID