THPDFButtonAction Type
Selects the /A action attached to a pushbutton form widget when the button is clicked (PDF 1.7 ISO 32000-1 12.6.4 / 12.7.5)
Declaration
THPDFButtonAction= (baNone, // Plain pushbutton, no /A entry
baSubmitURL, // /S /SubmitForm /F << /FS /URL /F (url) >> (PDF 1.2)
baResetForm, // /S /ResetForm (PDF 1.2)
baJavaScript, // /S /JavaScript /JS (code) (PDF 1.3)
baURI, // /S /URI /URI (url) (PDF 1.1)
baNamed, // v2.119.18 /S /Named /N <param> (PDF 1.1 §12.6.4.11)
// Built-in viewer commands: NextPage / PrevPage /
// FirstPage / LastPage. Acrobat extensions: Print,
// SaveAs, GoBack, GoForward, GoToPage. PDF/A allows
// the four standard nav names per §6.6.1
baHide, // v2.119.18 /S /Hide /T <field-name> /H true
// (PDF 1.2 §12.6.4.10). Hides the named widget(s);
// Param is the target field name. Spec /H default
// is true so we emit it explicitly to make the
// intent self-documenting
baShow, // v2.119.20 /S /Hide /T <field-name> /H false
// Mirror of baHide that re-shows the widget
// PDF/A + PDF/X allowed (widget visibility only)
baImportData); // v2.119.20 /S /ImportData /F (filename) (PDF 1.2Unit
HPDFDoc
Values
| Value | Meaning |
|---|---|
baNone | Plain pushbutton carrying no /A entry |
baSubmitURL | /SubmitForm action; Param is the submission URL (PDF 1.2) |
baResetForm | /ResetForm action that clears the form fields (PDF 1.2) |
baJavaScript | /JavaScript action; Param is the script text (PDF 1.3) |
baURI | /URI action that jumps to the URL in Param (PDF 1.1) |
baNamed | /Named action; Param is a built-in viewer command (NextPage, PrevPage, FirstPage, LastPage) or an Acrobat extension (Print, SaveAs, GoBack, GoForward, GoToPage); PDF/A accepts the four standard navigation names (PDF 1.1 §12.6.4.11) |
baHide | /Hide action with /H true; Param is the target field name whose widget(s) are hidden (PDF 1.2 §12.6.4.10) |
baShow | /Hide action with /H false that re-shows the widget named in Param; allowed in PDF/A and PDF/X (PDF 1.2) |
baImportData | /ImportData action; Param is the FDF file loaded into the form; forbidden in PDF/A and PDF/X documents (PDF 1.2 §12.7.5.4) |
Usage notes
- Pass a value of this type as the ActionType parameter of THPDFPage.AddPushButtonWithAction and THPDFPage.AddPushButtonWithNextAction; baNone creates a button without a /A entry
- Each value carries a minimum PDF version (HPDFButtonActionMinimumVersion) and the library rejects a requested action with a diagnostic when the document version is too low
- baImportData is rejected for PDF/A and PDF/X targets, matching the restrictions noted in the declaration comments