iText.Forms.Form.Element.SignatureFieldAppearance Class Reference

Extension of the FormField class representing a signature field in PDF. More...

Inheritance diagram for iText.Forms.Form.Element.SignatureFieldAppearance:

Public Member Functions
	SignatureFieldAppearance? (String id)
	Creates a new SignatureFieldAppearance instance. More...
virtual iText.Forms.Form.Element.SignatureFieldAppearance	SetContent (SignedAppearanceText description)
	Sets the content for this signature. More...
virtual iText.Forms.Form.Element.SignatureFieldAppearance	SetContent (String description)
	Sets the content for this signature. More...
virtual iText.Forms.Form.Element.SignatureFieldAppearance	SetContent (SignedAppearanceText description, ImageData image)
	Sets the content for this signature. More...
virtual iText.Forms.Form.Element.SignatureFieldAppearance	SetContent (String description, ImageData image)
	Sets the content for this signature. More...
virtual iText.Forms.Form.Element.SignatureFieldAppearance	SetContent (ImageData image)
	Sets the content for this signature. More...
virtual iText.Forms.Form.Element.SignatureFieldAppearance	SetContent (String signerName, SignedAppearanceText description)
	Sets the content for this signature. More...
virtual iText.Forms.Form.Element.SignatureFieldAppearance	SetContent (String signerName, String description)
	Sets the content for this signature. More...
virtual iText.Forms.Form.Element.SignatureFieldAppearance	SetContent (Div data)
	Sets the content for this signature. More...
virtual IList< IElement >	GetContentElements ()
	Gets the final content for this signature. More...
virtual SignedAppearanceText	GetSignedAppearanceText ()
	Gets the iText.Forms.Fields.Properties.SignedAppearanceText instance for this signature. More...
virtual void	SetSignerName (String signerName)
	Replaces the signer name for this signature if it was set by SetContent(iText.Forms.Fields.Properties.SignedAppearanceText). More...
override String	GetId ()
override AccessibilityProperties	GetAccessibilityProperties ()
	Gets the accessibility properties. More...
Public Member Functions inherited from iText.Forms.Form.Element.FormField< iText.Forms.Form.Element.SignatureFieldAppearance >
virtual T	SetSize (float size)
	Sets the form field's width and height. More...
virtual IFormField	SetWidth (float width)
virtual IFormField	SetHeight (float height)
virtual IFormField	SetValue (String value)
override T1	GetDefaultProperty< T1 > (int property)
virtual IFormField	SetInteractive (bool interactive)
virtual IFormField	SetAlternativeDescription (String alternativeDescription)
	Sets the form field's alternative description. More...

Protected Member Functions
override IRenderer	MakeNewRenderer ()

Additional Inherited Members
Package Attributes inherited from iText.Forms.Form.Element.FormField< iText.Forms.Form.Element.SignatureFieldAppearance >
DefaultAccessibilityProperties	tagProperties
	The tag properties. More...

Detailed Description

Extension of the FormField class representing a signature field in PDF.

Member Function Documentation

GetAccessibilityProperties()

override AccessibilityProperties iText.Forms.Form.Element.SignatureFieldAppearance.GetAccessibilityProperties ( )

inlinevirtual

Gets the accessibility properties.

Implements iText.Forms.Form.Element.FormField< iText.Forms.Form.Element.SignatureFieldAppearance >.

GetContentElements()

virtual IList<IElement> iText.Forms.Form.Element.SignatureFieldAppearance.GetContentElements ( )

inlinevirtual

Gets the final content for this signature.

Returns

collection of the layout elements which will be rendered as a signature content.

GetId()

override String iText.Forms.Form.Element.SignatureFieldAppearance.GetId ( )

inlinevirtual

Returns

Reimplemented from iText.Forms.Form.Element.FormField< iText.Forms.Form.Element.SignatureFieldAppearance >.

GetSignedAppearanceText()

virtual SignedAppearanceText iText.Forms.Form.Element.SignatureFieldAppearance.GetSignedAppearanceText ( )

inlinevirtual

Gets the iText.Forms.Fields.Properties.SignedAppearanceText instance for this signature.

Returns

iText.Forms.Fields.Properties.SignedAppearanceText instance if it was set by SetContent(iText.Forms.Fields.Properties.SignedAppearanceText) , null otherwise.

MakeNewRenderer()

override IRenderer iText.Forms.Form.Element.SignatureFieldAppearance.MakeNewRenderer ( )

inlineprotected

Returns

SetContent() [1/8]

virtual iText.Forms.Form.Element.SignatureFieldAppearance iText.Forms.Form.Element.SignatureFieldAppearance.SetContent ( Div  data )

inlinevirtual

Sets the content for this signature.

Parameters

data	the custom signature data which will be rendered.

Returns

this same SignatureFieldAppearance instance.

SetContent() [2/8]

virtual iText.Forms.Form.Element.SignatureFieldAppearance iText.Forms.Form.Element.SignatureFieldAppearance.SetContent ( ImageData  image )

inlinevirtual

Sets the content for this signature.

Parameters

image

the Image object to render.

Returns

this same SignatureFieldAppearance instance.

SetContent() [3/8]

virtual iText.Forms.Form.Element.SignatureFieldAppearance iText.Forms.Form.Element.SignatureFieldAppearance.SetContent ( SignedAppearanceText  description )

inlinevirtual

Sets the content for this signature.

Parameters

description

iText.Forms.Fields.Properties.SignedAppearanceText instance representing the signature text identifying the signer.

Returns

this same SignatureFieldAppearance instance.

SetContent() [4/8]

virtual iText.Forms.Form.Element.SignatureFieldAppearance iText.Forms.Form.Element.SignatureFieldAppearance.SetContent ( SignedAppearanceText  description, ImageData  image  )

inlinevirtual

Sets the content for this signature.

Parameters

description

iText.Forms.Fields.Properties.SignedAppearanceText instance representing the signature text identifying the signer.

Parameters

image

the Image object to render.

Returns

this same SignatureFieldAppearance instance.

SetContent() [5/8]

virtual iText.Forms.Form.Element.SignatureFieldAppearance iText.Forms.Form.Element.SignatureFieldAppearance.SetContent ( String  description )

inlinevirtual

Sets the content for this signature.

Parameters

description

the signature text identifying the signer.

Returns

this same SignatureFieldAppearance instance.

SetContent() [6/8]

virtual iText.Forms.Form.Element.SignatureFieldAppearance iText.Forms.Form.Element.SignatureFieldAppearance.SetContent ( String  description, ImageData  image  )

inlinevirtual

Sets the content for this signature.

Parameters

description	the signature text identifying the signer.
image	the Image object to render.

Returns

this same SignatureFieldAppearance instance.

SetContent() [7/8]

virtual iText.Forms.Form.Element.SignatureFieldAppearance iText.Forms.Form.Element.SignatureFieldAppearance.SetContent ( String  signerName, SignedAppearanceText  description  )

inlinevirtual

Sets the content for this signature.

Parameters

signerName	the name of the signer from the certificate.
description

iText.Forms.Fields.Properties.SignedAppearanceText instance representing the signature text identifying the signer.

Returns

this same SignatureFieldAppearance instance.

SetContent() [8/8]

virtual iText.Forms.Form.Element.SignatureFieldAppearance iText.Forms.Form.Element.SignatureFieldAppearance.SetContent ( String  signerName, String  description  )

inlinevirtual

Sets the content for this signature.

Parameters

signerName	the name of the signer from the certificate.
description	the signature text identifying the signer.

Returns

this same SignatureFieldAppearance instance.

SetSignerName()

virtual void iText.Forms.Form.Element.SignatureFieldAppearance.SetSignerName ( String  signerName )

inlinevirtual

Replaces the signer name for this signature if it was set by SetContent(iText.Forms.Fields.Properties.SignedAppearanceText).

Parameters

signerName

signer name to set.

SignatureFieldAppearance?()

iText.Forms.Form.Element.SignatureFieldAppearance.SignatureFieldAppearance? ( String  id )

inline

Creates a new SignatureFieldAppearance instance.

Parameters

id	signature field name if you use this SignatureFieldAppearance in pure layout for the new interactive signature field creation. ID will be ignored if this SignatureFieldAppearance is used for signing or for existing signature field