PDF SDK Documentation

Comprehensive Guide for Developers: Features, Integration, and API Reference

Loading...
Searching...
No Matches
PDF::FormField Class Reference

Represents a form field in a PDF document. More...

#include <pdfsdk/cxx/form_field.h>

Inheritance diagram for PDF::FormField:

Public Member Functions

PDAtom GetFieldType () const
 
PDFieldFlags GetFlags () const
 
std::wstring GetFullName () const
 
size_t GetChoiceNumOptions () const
 
std::wstring GetChoiceOption (size_t index) const
 
bool IsSignBlank () const
 
void SetSignLock (PDAtom action, PDObject fields, PDSignLockPerms perms)
 
PDAtom GetSignLockAction () const
 
PDF::Object GetSignLockFields () const
 
PDSignLockPerms GetSignLockPerms () const
 
void SignApprove (std::shared_ptr< SignHandler > signer, const std::wstring &reason)
 
void SignCertify (PDSignLockPerms perms, std::shared_ptr< SignHandler > signer, const std::wstring &reason)
 
void SignClear ()
 
bool SignVerify () const
 
bool SignDocModifiedAfterSign () const
 
std::wstring GetSignReason () const
 
PDDateTime GetSignDate () const
 
std::vector< uint8_t > GetSignCertificate () const
 
int GetSignRevision () const
 
 FormField (PDField handle, bool adopt=false) noexcept
 
 FormField (const FormField &rhs) noexcept
 
FormFieldoperator= (const FormField &rhs) noexcept
 
 FormField (FormField &&rhs) noexcept
 
FormFieldoperator= (FormField &&rhs) noexcept
 

Detailed Description

Represents a form field in a PDF document.

ISO 32000-2:2020 - 12.7 Forms

Member Function Documentation

◆ GetChoiceNumOptions()

size_t PDF::FormField::GetChoiceNumOptions ( ) const

Get the number of options for a choice form field.

Returns
The number of options for a choice form field as a size_t.

◆ GetChoiceOption()

std::wstring PDF::FormField::GetChoiceOption ( size_t index) const

Get the option at the specified index for a choice form field.

Parameters
indexThe index of the option to retrieve.
Returns
The option at the specified index as a wstring.

◆ GetFieldType()

PDAtom PDF::FormField::GetFieldType ( ) const

Get the type of the form field.

Returns
The type of the form field as a PDAtom.

◆ GetFlags()

PDFieldFlags PDF::FormField::GetFlags ( ) const

Get the flags of the form field.

Returns
The flags of the form field as PDFieldFlags.

◆ GetFullName()

std::wstring PDF::FormField::GetFullName ( ) const

Get the full name of the form field.

Returns
The full name of the form field as a wstring.

The documentation for this class was generated from the following file: