THPDFPage.AddPushButtonWithSoundAction Method
Adds push button with sound action data to the AcroForm workflow. The call creates or attaches the PDF-side object needed by later output, validation, signing, or page rendering steps
Declaration
procedure AddPushButtonWithSoundAction(const FieldName, Caption: AnsiString; Rectangle: TRect; const SoundFileName: AnsiString; const SoundParams: THPDFSoundParams; Volume: Single= 1.0; Repeating: boolean= false; Synchronous: boolean= false; Flags: THPDFFormFieldFlags= []); overload;
Unit
HPDFDoc
Parameters
| Name | Purpose |
|---|---|
FieldName | AcroForm field name or field dictionary targeted by the helper |
Caption | Human-readable text stored in the PDF object, action, annotation, or structure element |
Rectangle | Page area or widget rectangle where the operation is applied |
SoundFileName | File path used as the source or destination for this operation |
SoundParams | Input used by AddPushButtonWithSoundAction |
Volume | Input used by AddPushButtonWithSoundAction |
Repeating | Input used by AddPushButtonWithSoundAction |
Synchronous | Input used by AddPushButtonWithSoundAction |
Flags | Input used by AddPushButtonWithSoundAction |
Return value
This member does not return a value
Usage notes
- Use this API in the AcroForm workflow before the affected page, resource, field, or catalog object is finalised
- Keep object names, field names, resource names, and returned handles stable until the document is finalised
- Page-level changes affect subsequent operators on the same page; save and restore graphics state when a temporary setting should not leak