iText 8.0.5 API
iText.Signatures.SignerProperties Class Reference

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

Public Member Functions

  SignerProperties ()
  Create instance of SignerProperties. More...
 
virtual DateTime  GetSignDate ()
  Gets the signature date. More...
 
virtual iText.Signatures.SignerProperties  SetSignDate (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 layout element, which customizes the appearance of a signature. More...
 
virtual int  GetCertificationLevel ()
  Returns the document's certification level. More...
 
virtual iText.Signatures.SignerProperties  SetCertificationLevel (int certificationLevel)
  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...
 

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 int iText.Signatures.SignerProperties.GetCertificationLevel ( )
inlinevirtual

Returns the document's certification level.

Returns the document's certification level. For possible values see SetCertificationLevel(int).

Returns
The certified status.

◆ 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 layout element, which customizes the appearance of a signature.

Returns

iText.Forms.Form.Element.SignatureFieldAppearance layout element.

◆ GetSignatureCreator()

virtual String iText.Signatures.SignerProperties.GetSignatureCreator ( )
inlinevirtual

Returns the signature creator.

Returns
The signature creator.

◆ GetSignDate()

virtual DateTime iText.Signatures.SignerProperties.GetSignDate ( )
inlinevirtual

Gets the signature date.

Returns
Calendar set to the signature date.

◆ SetCertificationLevel()

virtual iText.Signatures.SignerProperties iText.Signatures.SignerProperties.SetCertificationLevel ( int  certificationLevel )
inlinevirtual

Sets the document's certification level.

Parameters
certificationLevel a new certification level for a document. Possible values are:
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.

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.

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.

Sets the page number of the signature field which this signature appearance is associated with. Implicitly calls PdfSigner.SetPageRect(iText.Kernel.Geom.Rectangle) which considers page number to process the rectangle correctly.

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.

Sets the signature field layout element to customize the appearance of the signature. Signer's sign date will be set.

Parameters
appearance the iText.Forms.Form.Element.SignatureFieldAppearance layout element.
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.

◆ SetSignDate()

virtual iText.Signatures.SignerProperties iText.Signatures.SignerProperties.SetSignDate ( DateTime  signDate )
inlinevirtual

Sets the signature date.

Parameters
signDate the signature date.
Returns
this instance to support fluent interface.