Interface: FlowPushButtonOptions
Options for placing a push-button form field through the flow layout API.
Extends
Omit<PushButtonOptions,"x"|"y"|"width">.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
actions? | FieldActions | JavaScript actions attached to this field's /AA dictionary. Each action value is raw PDF JavaScript source code. | PushButtonOptions.actions |
appearance? | string | Custom appearance stream content for the push button. Example: "1 0 0 rg 0 0 100 20 re f" | PushButtonOptions.appearance |
borderWidth? | number | Annotation or field border width in PDF points. | PushButtonOptions.borderWidth |
color? | ColorInput | Color used for drawing, text, or highlighting. | PushButtonOptions.color |
description? | string | Field description, emitted as /TU (the field's user-facing name). Assistive technology reads it as the field's accessible name, and it satisfies the "form fields have a description" accessibility check. | PushButtonOptions.description |
encrypt? | boolean | Whether the field value follows document encryption. When false, the field value is not encrypted (useful for searchable fields). Defaults to true (follow document encryption). | PushButtonOptions.encrypt |
font? | FontName | Font used to render text. | PushButtonOptions.font |
fontSize? | number | Font size in PDF points. | PushButtonOptions.fontSize |
height | number | Height in PDF points. | PushButtonOptions.height |
label | string | Explicit list marker or button label text. | PushButtonOptions.label |
margin? | FlowMarginShorthand | CSS-like margin shorthand in PDF points. | FlowBlockSpacingOptions.margin |
marginBottom? | number | Bottom margin in PDF points. | FlowBlockSpacingOptions.marginBottom |
marginLeft? | number | Left margin in PDF points. | FlowBlockSpacingOptions.marginLeft |
marginRight? | number | Right margin in PDF points. | FlowBlockSpacingOptions.marginRight |
marginTop? | number | Top margin in PDF points. | FlowBlockSpacingOptions.marginTop |
readOnly? | boolean | Whether the form field is read-only. | PushButtonOptions.readOnly |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | PushButtonOptions.structure |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | PushButtonOptions.tag |
width? | number | Width override in PDF points. | - |
x? | number | Horizontal position override in PDF points. | - |
y? | number | Vertical position override in PDF points. | - |