FOM Reference > Content > PDF Controls > fPDFFormPushButton interface
  
fPDFFormPushButton interface
This object represents a PDF Form push button item. This object inherits from fPDFFormItem.
HighlightModes enumeration
How to highlight the form item when it is clicked on.
The HighlightModes enumeration has the following constants of type int.
HIGHLIGHT_NONE = 0
Don't highlight the form item.
HIGHLIGHT_INVERT = 1
Invert the colors for the form item.
HIGHLIGHT_OUTLINE = 2
Draw an outline around the form item.
HIGHLIGHT_PUSH = 3
Change the outline for the form item to make it look like it's pushed.
ButtonLayouts enumeration
Where to place the caption relative to the icon.
The ButtonLayouts enumeration has the following constants of type int.
LAYOUT_BELOW = 0
Place the caption below the icon.
LAYOUT_ABOVE = 1
Place the caption above the icon.
LAYOUT_RIGHT = 2
Place the caption to the right of the icon.
LAYOUT_LEFT = 3
Place the caption to the left of the icon.
LAYOUT_OVERLAID = 4
Place the caption on top of the icon.
FitMethods enumeration
How to fit the icon inside the button.
The FitMethods enumeration has the following constants of type int.
FIT_AUTO = 0
If the icon fits inside the button, FIT_MEET. Otherwise, FIT_CLIP.
FIT_CLIP = 1
The icon will be clipped at the button edges.
FIT_MEET = 2
The icon will be scaled proportionally to fit.
FIT_ENTIRE = 3
The icon will be scaled to fit entirely inside the button.
buttonLayout attribute
The position of the button caption relative to the icon, if both properties have been set. Valid values are in fPDFFormPushButton-ButtonLayouts.
buttonLayout
Access
read-write
Returns
int
caption attribute
The text label to display on the button. Either caption or icon properties need to be set.
caption
Access
read-write
Returns
String
captionDown attribute
The text label to display when the button is activated. This property is only used when highlight is set to fPDFFormPushButton-HIGHLIGHT_PUSH.
captionDown
Access
read-write
Returns
String
captionRollover attribute
The text label to display when the button does have input focus. This property is only used when highlight is set to fPDFFormPushButton-HIGHLIGHT_PUSH.
captionRollover
Access
read-write
Returns
String
charSpacing attribute
The character spacing for text in the form item.
charSpacing
Access
read-write
Returns
fLength
fitMethod attribute
How to fit the icon within the button. Valid values are in fPDFFormPushButton-FitMethods.
fitMethod
Access
read-write
Returns
int
highlight attribute
The style to use to highlight the form item when it is clicked on. Valid values are in fPDFFormPushButton-HighlightModes.
highlight
Access
read-write
Returns
int
icon attribute
The icon to display on the button. Either caption or icon properties need to be set.
icon
Access
read-write
Returns
fRaster
iconDown attribute
The icon to display when the button is activated. This property is only used when highlight is set to fPDFFormPushButton-HIGHLIGHT_PUSH.
iconDown
Access
read-write
Returns
fRaster
iconRollover attribute
The icon to display when the button does have input focus. This property is only used when highlight is set to fPDFFormPushButton-HIGHLIGHT_PUSH.
iconRollover
Access
read-write
Returns
fRaster
positionBottom attribute
Where to place the image relative to the bottom edge of the button. This value is a percentage, where 0 is the bottom edge, and 100 is the top edge. 50 will center the icon vertically.
positionBottom
Access
read-write
Returns
float
positionLeft attribute
Where to place the image relative to the left edge of the button. This value is a percentage, where 0 is the left edge, and 100 is the right edge. 50 will center the icon horizontally.
positionLeft
Access
read-write
Returns
float
submitName attribute
URL to submit the values in the form items to.
submitName
Access
read-write
Returns
String