Class SignerProperties

Namespace

iText.Signatures

Assembly

itext.sign.dll

Properties to be used in signing operations.

public class SignerProperties

Inheritance

object

SignerProperties

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SignerProperties()

Create instance of SignerProperties.

public SignerProperties()

Methods

GetCertificationLevel()

Returns the document's certification level.

public virtual int GetCertificationLevel()

Returns

int

The certified status.

Remarks

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

GetContact()

Returns the signing contact.

public virtual string GetContact()

Returns

string

The signing contact.

GetFieldLockDict()

Getter for the field lock dictionary.

public virtual PdfSigFieldLock GetFieldLockDict()

Returns

PdfSigFieldLock

Field lock dictionary.

GetFieldName()

Gets the field name.

public virtual string GetFieldName()

Returns

string

the field name.

GetLocation()

Returns the signing location.

public virtual string GetLocation()

Returns

string

The signing location.

GetPageNumber()

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

public virtual int GetPageNumber()

Returns

int

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

GetPageRect()

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

public virtual Rectangle GetPageRect()

Returns

Rectangle

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

GetReason()

Returns the signing reason.

public virtual string GetReason()

Returns

string

The signing reason.

GetSignDate()

Gets the signature date.

public virtual DateTime GetSignDate()

Returns

DateTime

Calendar set to the signature date.

GetSignatureAppearance()

Gets signature field layout element, which customizes the appearance of a signature.

public virtual SignatureFieldAppearance GetSignatureAppearance()

Returns

SignatureFieldAppearance

SignatureFieldAppearance layout element.

GetSignatureCreator()

Returns the signature creator.

public virtual string GetSignatureCreator()

Returns

string

The signature creator.

SetCertificationLevel(int)

Sets the document's certification level.

public virtual SignerProperties SetCertificationLevel(int certificationLevel)

Parameters

certificationLevel int

a new certification level for a document. Possible values are:

• NOT_CERTIFIED
• CERTIFIED_NO_CHANGES_ALLOWED
• CERTIFIED_FORM_FILLING
• CERTIFIED_FORM_FILLING_AND_ANNOTATIONS

Returns

SignerProperties

this instance to support fluent interface.

SetContact(string)

Sets the signing contact.

public virtual SignerProperties SetContact(string contact)

Parameters

contact string

A new signing contact.

Returns

SignerProperties

this instance to support fluent interface.

SetFieldLockDict(PdfSigFieldLock)

Setter for the field lock dictionary.

public virtual SignerProperties SetFieldLockDict(PdfSigFieldLock fieldLock)

Parameters

fieldLock PdfSigFieldLock

Field lock dictionary.

Returns

SignerProperties

this instance to support fluent interface.

Remarks

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

SetFieldName(string)

Sets the name indicating the field to be signed.

public virtual SignerProperties SetFieldName(string fieldName)

Parameters

fieldName string

The name indicating the field to be signed.

Returns

SignerProperties

this instance to support fluent interface.

Remarks

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.

SetLocation(string)

Sets the signing location.

public virtual SignerProperties SetLocation(string location)

Parameters

location string

A new signing location.

Returns

SignerProperties

this instance to support fluent interface.

SetPageNumber(int)

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

public virtual SignerProperties SetPageNumber(int pageNumber)

Parameters

pageNumber int

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

Returns

SignerProperties

this instance to support fluent interface.

Remarks

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

SetPageRect(Rectangle)

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

public virtual SignerProperties SetPageRect(Rectangle pageRect)

Parameters

pageRect Rectangle

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

Returns

SignerProperties

this instance to support fluent interface.

SetReason(string)

Sets the signing reason.

public virtual SignerProperties SetReason(string reason)

Parameters

reason string

A new signing reason.

Returns

SignerProperties

this instance to support fluent interface.

SetSignDate(DateTime)

Sets the signature date.

public virtual SignerProperties SetSignDate(DateTime signDate)

Parameters

signDate DateTime

the signature date.

Returns

SignerProperties

this instance to support fluent interface.

SetSignatureAppearance(SignatureFieldAppearance)

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

public virtual SignerProperties SetSignatureAppearance(SignatureFieldAppearance appearance)

Parameters

appearance SignatureFieldAppearance

the SignatureFieldAppearance layout element.

Returns

SignerProperties

this instance to support fluent interface.

Remarks

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

SetSignatureCreator(string)

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

public virtual SignerProperties SetSignatureCreator(string signatureCreator)

Parameters

signatureCreator string

A new name of the application signing a document.

Returns

SignerProperties

this instance to support fluent interface.