A signature field lock dictionary. More...

Inheritance diagram for iText.Forms.PdfSigFieldLock:

Public Types
enum	LockAction { ALL, INCLUDE, EXCLUDE }
	Enumerates the different actions of a signature field lock. More...

enum	LockPermissions { NO_CHANGES_ALLOWED, FORM_FILLING, FORM_FILLING_AND_ANNOTATION }
	Enumerates the different levels of access permissions granted for the document when the corresponding signature field is signed: NO_CHANGES_ALLOWED More...

Public Member Functions
	PdfSigFieldLock ()
	Creates an instance of PdfSigFieldLock. More...

	PdfSigFieldLock (PdfDictionary dict)
	Creates an instance of PdfSigFieldLock. More...

virtual iText.Forms.PdfSigFieldLock	SetDocumentPermissions (PdfSigFieldLock.LockPermissions permissions)
	Sets the permissions granted for the document when the corresponding signature field is signed. More...

virtual iText.Forms.PdfSigFieldLock	SetFieldLock (PdfSigFieldLock.LockAction action, params String[] fields)
	Sets signature lock for specific fields in the document. More...

Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T	GetPdfObject ()

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document, PdfIndirectReference reference)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	SetModified ()

virtual void	Flush ()

virtual bool	IsFlushed ()

Static Public Member Functions
static PdfName	GetLockActionValue (PdfSigFieldLock.LockAction action)
	Returns the specified action of a signature field lock as iText.Kernel.Pdf.PdfName value. More...

static PdfNumber	GetLockPermission (PdfSigFieldLock.LockPermissions permissions)
	Returns the specified level of access permissions granted for the document as iText.Kernel.Pdf.PdfNumber value. More...

Protected Member Functions
override bool	IsWrappedObjectMustBeIndirect ()
	Defines if the object behind this wrapper must be an indirect object in the resultant document. More...

Additional Inherited Members
Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
	PdfObjectWrapper (T pdfObject)

virtual void	SetPdfObject (T pdfObject)

virtual void	SetForbidRelease ()

virtual void	UnsetForbidRelease ()

virtual void	EnsureUnderlyingObjectHasIndirectReference ()

Static Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
static void	MarkObjectAsIndirect (PdfObject pdfObject)

static void	EnsureObjectIsAddedToDocument (PdfObject @object)
	Some wrappers use object's indirect reference to obtain the `PdfDocument` to which the object belongs to. More...

Detailed Description

A signature field lock dictionary.

A signature field lock dictionary. Specifies a set of form fields that shall be locked when this signature field is signed.

Member Enumeration Documentation

◆ LockAction

enum iText.Forms.PdfSigFieldLock.LockAction

strong

Enumerates the different actions of a signature field lock.

Enumerates the different actions of a signature field lock. Indicates the set of fields that should be locked when the corresponding signature field is signed:

all the fields in the document,
all the fields specified in the /Fields array,
all the fields except those specified in the /Fields array.

◆ LockPermissions

enum iText.Forms.PdfSigFieldLock.LockPermissions

strong

Enumerates the different levels of access permissions granted for the document when the corresponding signature field is signed:

NO_CHANGES_ALLOWED

no changes to the document are permitted; any change to the document invalidates the signature, FORM_FILLING
permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature, FORM_FILLING_AND_ANNOTATION
permitted changes are the same as for the previous, as well as annotation creation, deletion, and modification; other changes invalidate the signature.

Enumerates the different levels of access permissions granted for the document when the corresponding signature field is signed:

NO_CHANGES_ALLOWED
- no changes to the document are permitted; any change to the document invalidates the signature,
FORM_FILLING
- permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature,
FORM_FILLING_AND_ANNOTATION
- permitted changes are the same as for the previous, as well as annotation creation, deletion, and modification; other changes invalidate the signature.

Constructor & Destructor Documentation

◆ PdfSigFieldLock() [1/2]

iText.Forms.PdfSigFieldLock.PdfSigFieldLock ( )

inline

Creates an instance of PdfSigFieldLock.

◆ PdfSigFieldLock() [2/2]

iText.Forms.PdfSigFieldLock.PdfSigFieldLock ( PdfDictionary dict )

inline

Creates an instance of PdfSigFieldLock.

Parameters

dict	the dictionary whose entries should be added to the signature field lock dictionary

Member Function Documentation

◆ GetLockActionValue()

static PdfName iText.Forms.PdfSigFieldLock.GetLockActionValue ( PdfSigFieldLock.LockAction action )

inlinestatic

Returns the specified action of a signature field lock as iText.Kernel.Pdf.PdfName value.

Parameters

action the action as LockAction

Returns: the specified action of a signature field lock as iText.Kernel.Pdf.PdfName.

◆ GetLockPermission()

static PdfNumber iText.Forms.PdfSigFieldLock.GetLockPermission ( PdfSigFieldLock.LockPermissions permissions )

inlinestatic

Returns the specified level of access permissions granted for the document as iText.Kernel.Pdf.PdfNumber value.

Parameters

permissions the level of access permissions as LockPermissions

Returns: the specified level of access permissions as iText.Kernel.Pdf.PdfNumber.

◆ IsWrappedObjectMustBeIndirect()

override bool iText.Forms.PdfSigFieldLock.IsWrappedObjectMustBeIndirect ( )

inlineprotectedvirtual

Defines if the object behind this wrapper must be an indirect object in the resultant document.

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Returns: true if in the resultant document the object behind the wrapper must be indirect, otherwise false.

Implements iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >.

◆ SetDocumentPermissions()

virtual iText.Forms.PdfSigFieldLock iText.Forms.PdfSigFieldLock.SetDocumentPermissions ( PdfSigFieldLock.LockPermissions permissions )

inlinevirtual

Sets the permissions granted for the document when the corresponding signature field is signed.

Sets the permissions granted for the document when the corresponding signature field is signed. See LockPermissions for getting more info.

Parameters

permissions the permissions granted for the document

Returns: this PdfSigFieldLock object.

◆ SetFieldLock()

virtual iText.Forms.PdfSigFieldLock iText.Forms.PdfSigFieldLock.SetFieldLock	(	PdfSigFieldLock.LockAction	action,
		params String[]	fields
	)

inlinevirtual

Sets signature lock for specific fields in the document.

Parameters

action	indicates the set of fields that should be locked after the actual signing of the corresponding signature takes place
fields	names indicating the fields

Returns: this PdfSigFieldLock object.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ LockAction

◆ LockPermissions

Constructor & Destructor Documentation

◆ PdfSigFieldLock() [1/2]

◆ PdfSigFieldLock() [2/2]

Member Function Documentation

◆ GetLockActionValue()

◆ GetLockPermission()

◆ IsWrappedObjectMustBeIndirect()

◆ SetDocumentPermissions()

◆ SetFieldLock()