class HexaPDF::Type::AcroForm::SignatureField

Parent

AcroForm signature fields represent a digital signature.

It serves two purposes: To visually display the signature and to hold the information of the digital signature itself.

If the signature should not be visible, the associated widget annotation should have zero width and height; and/or the ‘hidden’ or ‘no_view’ flags of the annotation should be set.

See: PDF2.0 s12.7.5.5

Field Definitions

NameType/Allowed ValuesRequiredDefault Value
FTSymbol
One of: :Btn, :Tx, :Ch, :Sig
falsenil
ParentHexaPDF::Type::AcroForm::Field or Hashfalsenil
KidsHexaPDF::PDFArray or Arrayfalsenil
TStringfalsenil
TUStringfalsenil
TMStringfalsenil
FfIntegerfalse0
VHexaPDF::Dictionary or Symbol or String or HexaPDF::Stream or HexaPDF::PDFArray or Hash or Arrayfalsenil
DVHexaPDF::Dictionary or Symbol or String or HexaPDF::Stream or HexaPDF::PDFArray or Hash or Arrayfalsenil
AAHexaPDF::Dictionary or Hashfalsenil
LockHexaPDF::Type::AcroForm::SignatureField::LockDictionary or Hashfalsenil
SVHexaPDF::Type::AcroForm::SignatureField::SeedValueDictionary or Hashfalsenil

Public Instance Methods

field_value()

Returns the associated signature dictionary or nil if the signature is not filled in.

field_value=(sig_dict)

Sets the signature dictionary as value of this signature field.