Class PdfFieldLock

Namespace

MiPdf.Signatures

Assembly

MiPdf.dll

Field lock (FieldMDP, ISO 32000 12.8.2.4): the form fields that become read-only once a signature field is signed. The signature covers the lock, so a later change of a locked field makes the signature invalid in validators such as Adobe Acrobat instead of being reported as permitted form filling.

public sealed class PdfFieldLock

Inheritance

object

PdfFieldLock

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Remarks

Set it on FieldLock when signing, or define it in advance on an unsigned signature field with Lock (the lock is then applied by whoever signs it). Field names are fully qualified names such as "address.street".

Properties

Action

Whether all fields, only the listed Fields or all except them are locked.

public FieldLockAction Action { get; }

Property Value

FieldLockAction

Fields

The listed fields (empty for All).

public IReadOnlyList<string> Fields { get; }

Property Value

IReadOnlyList<string>

Methods

All()

Locks all form fields.

public static PdfFieldLock All()

Returns

PdfFieldLock

Exclude(params string[])

Locks all fields except the given ones.

public static PdfFieldLock Exclude(params string[] fields)

Parameters

fields string[]

Returns

PdfFieldLock

Include(params string[])

Locks the given fields.

public static PdfFieldLock Include(params string[] fields)

Parameters

fields string[]

Returns

PdfFieldLock

Locks(string)

Returns whether the field with the given fully qualified name is locked.

public bool Locks(string fieldName)

Parameters

fieldName string

Returns

bool

ToString()

Returns "All", or the action followed by the field names, e.g. "Include: name, date".

public override string ToString()

Returns

string