Class PdfSigFieldLock

Namespace

iText.Forms

Assembly

itext.forms.dll

A signature field lock dictionary.

public class PdfSigFieldLock : PdfObjectWrapper<PdfDictionary>

Inheritance

object

PdfObjectWrapper<PdfDictionary>

PdfSigFieldLock

Inherited Members

PdfObjectWrapper<PdfDictionary>.GetPdfObject()

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument, PdfIndirectReference)

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument)

PdfObjectWrapper<PdfDictionary>.SetModified()

PdfObjectWrapper<PdfDictionary>.Flush()

PdfObjectWrapper<PdfDictionary>.IsFlushed()

PdfObjectWrapper<PdfDictionary>.SetPdfObject(PdfDictionary)

PdfObjectWrapper<PdfDictionary>.SetForbidRelease()

PdfObjectWrapper<PdfDictionary>.UnsetForbidRelease()

PdfObjectWrapper<PdfDictionary>.EnsureUnderlyingObjectHasIndirectReference()

PdfObjectWrapper<PdfDictionary>.MarkObjectAsIndirect(PdfObject)

PdfObjectWrapper<PdfDictionary>.EnsureObjectIsAddedToDocument(PdfObject)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

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

Constructors

PdfSigFieldLock()

Creates an instance of PdfSigFieldLock.

public PdfSigFieldLock()

PdfSigFieldLock(PdfDictionary)

Creates an instance of PdfSigFieldLock.

public PdfSigFieldLock(PdfDictionary dict)

Parameters

dict PdfDictionary

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

Methods

GetLockActionValue(LockAction)

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

public static PdfName GetLockActionValue(PdfSigFieldLock.LockAction action)

Parameters

action PdfSigFieldLock.LockAction

the action as PdfSigFieldLock.LockAction

Returns

PdfName

the specified action of a signature field lock as PdfName.

GetLockPermission(LockPermissions)

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

public static PdfNumber GetLockPermission(PdfSigFieldLock.LockPermissions permissions)

Parameters

permissions PdfSigFieldLock.LockPermissions

the level of access permissions as PdfSigFieldLock.LockPermissions

Returns

PdfNumber

the specified level of access permissions as PdfNumber.

IsWrappedObjectMustBeIndirect()

protected override bool IsWrappedObjectMustBeIndirect()

Returns

bool

SetDocumentPermissions(LockPermissions)

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

public virtual PdfSigFieldLock SetDocumentPermissions(PdfSigFieldLock.LockPermissions permissions)

Parameters

permissions PdfSigFieldLock.LockPermissions

the permissions granted for the document

Returns

PdfSigFieldLock

this PdfSigFieldLock object.

Remarks

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

SetFieldLock(LockAction, params string[])

Sets signature lock for specific fields in the document.

public virtual PdfSigFieldLock SetFieldLock(PdfSigFieldLock.LockAction action, params string[] fields)

Parameters

action PdfSigFieldLock.LockAction

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

fields string[]

names indicating the fields

Returns

PdfSigFieldLock

this PdfSigFieldLock object.