PdfSignatureLockedFieldCollection Class

Namespace:
GemBox.Pdf.Forms
Assembly:
GemBox.Pdf.dll

Represents a set of form fields whose change invalidate the signature.

public sealed class PdfSignatureLockedFieldCollection : PdfCollection<String>, IList, ICollection, IList<String>, ICollection<String>, IEnumerable<String>, IEnumerable
Public NotInheritable Class PdfSignatureLockedFieldCollection
    Inherits PdfCollection(Of String)
    Implements IList, ICollection, IList(Of String), ICollection(Of String), IEnumerable(Of String), IEnumerable
Inheritance:
System.Object
PdfCollection<System.String>
PdfSignatureLockedFieldCollection
Implements
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<System.String>
System.Collections.Generic.ICollection<System.String>
System.Collections.Generic.IEnumerable<System.String>
System.Collections.IEnumerable

Properties

All

Gets or sets a value indicating whether the change of any form field in the document invalidate the signature.

public bool All { get; set; }
Public Property All As Boolean
Property Value
System.Boolean

true if the change of any form field in the document invalidate the signature; otherwise, false.

Excluded

Gets or sets a value indicating whether the change of any form field NOT contained in this PdfSignatureLockedFieldCollection invalidate the signature.

public bool Excluded { get; set; }
Public Property Excluded As Boolean
Property Value
System.Boolean

true if the change of any form field NOT contained in this PdfSignatureLockedFieldCollection invalidate the signature; otherwise, false.

Permission

(Optional; PDF 2.0) The access permissions granted for this document. Valid values shall be:

  • None - No changes to the document are permitted; any change to the document shall invalidate the signature.
  • FillForm - Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature.
  • CommentAndFillForm - Permitted changes are the same as for FillForm, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature.

The default value, null, shall result in no effect on signature validation rules.

If the Permission is already in effect from an earlier incremental save section or the original part of the document (via AuthorPermission), the value shall specify permission less than or equal to the permission already in effect based on signatures earlier in the document. That is, permission can be denied but not added. If the value specifies greater permission than a value already in effect, the new value is ignored.

If the document does not have an author signature (AuthorPermission is null), the initial permission in effect is those based on the CommentAndFillForm.

The new permission applies to any incremental changes to the document following the signature of which this PdfSignatureLockedFieldCollection is part.

public PdfUserAccessPermissions? Permission { get; set; }
Public Property Permission As PdfUserAccessPermissions?
Property Value
System.Nullable<PdfUserAccessPermissions>

The access permissions granted for this document.

Exceptions
System.NotSupportedException
See Also

Methods

Add(PdfField)

Adds a Name of the PdfField to the end of the PdfSignatureLockedFieldCollection.

public void Add(PdfField field)
Public Sub Add(field As PdfField)
Parameters
field
PdfField

The PdfField whose Name is to be added to the end of the PdfSignatureLockedFieldCollection.

Exceptions
System.ArgumentNullException

field

System.ArgumentNullException

field is null.

System.InvalidOperationException

The Excluded property of a PdfSignatureLockedFieldCollection must be set (to either false or true) before the PdfSignatureLockedFieldCollection can be modified.

Inherited Properties

Count

Gets the number of elements contained in the PdfCollection.

(Inherited from PdfCollection)

Metadata

(Optional; PDF 1.4) A metadata stream containing metadata for the component.

(Inherited from PdfObject)

Inherited Methods

Clear()

Removes all elements from the PdfCollection.

(Inherited from PdfCollection)

RemoveAt(System.Int32)

Removes the element at the specified index of the PdfCollection.

(Inherited from PdfCollection)

Implements

System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<T>
System.Collections.Generic.ICollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable

Extension Methods

See Also