iText 8.0.5 API
iText.Forms.Fields.Properties.SignedAppearanceText Class Reference

Class representing the signature text identifying the signer. More...

Public Member Functions

  SignedAppearanceText ()
  Creates a new SignedAppearanceText instance. More...
 
virtual String  GetReasonLine ()
  Returns the signing reason. More...
 
virtual iText.Forms.Fields.Properties.SignedAppearanceText  SetReasonLine (String reason)
  Sets the signing reason. More...
 
virtual String  GetLocationLine ()
  Returns the signing location. More...
 
virtual iText.Forms.Fields.Properties.SignedAppearanceText  SetLocationLine (String location)
  Sets the signing location. More...
 
virtual iText.Forms.Fields.Properties.SignedAppearanceText  SetSignedBy (String signedBy)
  Sets the name of the signer from the certificate. More...
 
virtual String  GetSignedBy ()
  Gets the name of the signer from the certificate. More...
 
virtual DateTime  GetSignDate ()
  Returns the signature date. More...
 
virtual iText.Forms.Fields.Properties.SignedAppearanceText  SetSignDate (DateTime signDate)
  Sets the signature date. More...
 
virtual String  GenerateDescriptionText ()
  Generates the signature description text based on the provided parameters. More...
 

Detailed Description

Class representing the signature text identifying the signer.

Constructor & Destructor Documentation

◆ SignedAppearanceText()

iText.Forms.Fields.Properties.SignedAppearanceText.SignedAppearanceText ( )
inline

Creates a new SignedAppearanceText instance.

Member Function Documentation

◆ GenerateDescriptionText()

virtual String iText.Forms.Fields.Properties.SignedAppearanceText.GenerateDescriptionText ( )
inlinevirtual

Generates the signature description text based on the provided parameters.

Returns
signature description.

◆ GetLocationLine()

virtual String iText.Forms.Fields.Properties.SignedAppearanceText.GetLocationLine ( )
inlinevirtual

Returns the signing location.

Returns
signing location.

◆ GetReasonLine()

virtual String iText.Forms.Fields.Properties.SignedAppearanceText.GetReasonLine ( )
inlinevirtual

Returns the signing reason.

Returns
reason for signing.

◆ GetSignDate()

virtual DateTime iText.Forms.Fields.Properties.SignedAppearanceText.GetSignDate ( )
inlinevirtual

Returns the signature date.

Returns
the signature date

◆ GetSignedBy()

virtual String iText.Forms.Fields.Properties.SignedAppearanceText.GetSignedBy ( )
inlinevirtual

Gets the name of the signer from the certificate.

Returns
signedBy name of the signer.

◆ SetLocationLine()

virtual iText.Forms.Fields.Properties.SignedAppearanceText iText.Forms.Fields.Properties.SignedAppearanceText.SetLocationLine ( String  location )
inlinevirtual

Sets the signing location.

Sets the signing location.

Note, that this location won't be passed to the signature dictionary. If none is set, value set by PdfSigner::setLocation will be used.

Parameters
location new signing location.
Returns
this same SignedAppearanceText instance.

◆ SetReasonLine()

virtual iText.Forms.Fields.Properties.SignedAppearanceText iText.Forms.Fields.Properties.SignedAppearanceText.SetReasonLine ( String  reason )
inlinevirtual

Sets the signing reason.

Sets the signing reason.

Note, that this reason won't be passed to the signature dictionary. If none is set, value set by PdfSigner::setReason will be used.

Parameters
reason signing reason.
Returns
this same SignedAppearanceText instance.

◆ SetSignDate()

virtual iText.Forms.Fields.Properties.SignedAppearanceText iText.Forms.Fields.Properties.SignedAppearanceText.SetSignDate ( DateTime  signDate )
inlinevirtual

Sets the signature date.

Sets the signature date.

Note, that the signing date will be replaced by the one from the PdfSigner during the signing.

Parameters
signDate new signature date.
Returns
this same SignedAppearanceText instance.

◆ SetSignedBy()

virtual iText.Forms.Fields.Properties.SignedAppearanceText iText.Forms.Fields.Properties.SignedAppearanceText.SetSignedBy ( String  signedBy )
inlinevirtual

Sets the name of the signer from the certificate.

Sets the name of the signer from the certificate.

Note, that the signer name will be replaced by the one from the signing certificate during the actual signing.

Parameters
signedBy name of the signer.
Returns
this same SignedAppearanceText instance.