THPDFActionBuilder Class

Builds reusable PDF action dictionaries for document open actions, annotation actions, annotation additional actions, form-field and widget additional actions, and push button actions

Declaration

THPDFActionBuilder = class(TObject)

Unit

HPDFDoc

Parameters

Name	Purpose
`URI`	Input used by the THPDFActionBuilder workflow
`JavaScript`	Input used by the THPDFActionBuilder workflow
`SubmitForm`	Input used by the THPDFActionBuilder workflow
`SubmitFormFields`	Builds a submit action scoped to named form fields
`ResetForm`	Input used by the THPDFActionBuilder workflow
`ResetFormFields`	Builds a reset action scoped to named form fields
`Hide`	Input used by the THPDFActionBuilder workflow
`Show`	Input used by the THPDFActionBuilder workflow
`ImportData`	Input used by the THPDFActionBuilder workflow
`Named`	Input used by the THPDFActionBuilder workflow
`GoToNamedDestination`	Input used by the THPDFActionBuilder workflow
`GoToPage`	Builds a local page navigation action with a direct page destination
`GoToRemote`	Builds a remote document navigation action that targets a page index
`GoToRemotePage`	Builds a remote document navigation action with fit-mode destination coordinates
`GoToRemoteNamedDestination`	Builds a remote document navigation action that targets a named destination
`Launch`	Builds an external file Launch action with optional new-window behaviour
`Thread`	Builds a document-thread navigation action that targets a named thread destination
`Sound`	Builds a Sound action from caller supplied audio bytes and `THPDFSoundParams`
`Movie`	Builds a Movie action for a dictionary returned by `AddMovieAnnotation`
`Rendition`	Builds a Rendition action for a Screen annotation and media file specification
`SetOCGState`	Builds a layer visibility action for a registered optional content group
`ShowLayer`	Builds a SetOCGState action that turns a layer on
`HideLayer`	Builds a SetOCGState action that turns a layer off
`ToggleLayer`	Builds a SetOCGState action that toggles a layer
`Transition`	Builds a Trans action with a page-transition dictionary
`GoTo3DView`	Builds a GoTo3DView action for a 3D annotation and view name
`ThenAction`	Input used by the THPDFActionBuilder workflow

Usage notes

ThenAction owns the supplied next builder
Callers can free the builder after HotPDF builds the PDF action dictionary
GoToPage uses a zero-based page index and validates the target against pages already present in the document
GoToRemotePage uses a zero-based page index in the remote document and accepts the same fit modes as GoToPage
SubmitFormFields and ResetFormFields write the Fields array from Unicode-safe field names
GoToRemoteNamedDestination and Launch normalize Windows file separators in emitted file specifications
Launch is rejected automatically when PDF/A or PDF/X conformance is active
Sound, Movie, Rendition, SetOCGState, Transition, and GoTo3DView are rejected automatically when PDF/A or PDF/X conformance is active
SetOCGState requires a layer name returned by RegisterOptionalContentGroup
Movie, Rendition, and GoTo3DView consume annotation dictionaries returned by the matching annotation helpers or LastAnnotation
Use document lifecycle action helpers, SetAnnotationAdditionalAction, SetFormFieldAdditionalAction, the form-field action convenience helpers, and SetPageAdditionalAction when the same builder chain must run from catalog, annotation, form-field, widget, or page trigger dictionaries
Use this API when an application needs this PDF action builder workflow in a loaded or generated PDF document

THPDFActionBuilder Class

Declaration

Unit

Parameters

Usage notes

Related API