FOM Reference > Content > PDF Controls > fPDFFormItem interface
  
fPDFFormItem interface
This object represents a PDF Form item, and is the base object for all other form item objects. This object inherits from fControl.
AlignmentTypes enumeration
How to align the text in the form item.
The AlignmentTypes enumeration has the following constants of type int.
ALIGNMENT_LEFT = 0
Align text to the left.
ALIGNMENT_CENTER = 1
Align text to the center.
ALIGNMENT_RIGHT = 2
Align text to the right.
BorderStyles enumeration
The style of border to draw around the form item.
The BorderStyles enumeration has the following constants of type int.
BORDER_SOLID = 0
A solid line.
BORDER_BEVEL = 1
A solid line with bevelled corners.
BORDER_DASH = 2
A dashed line.
BORDER_INSET = 3
A solid line with inset edges.
BORDER_UNDERLINE = 4
A solid line under the form item.
DisplayModes enumeration
Whether the form item should be visible or not.
The DisplayModes enumeration has the following constants of type int.
DISPLAY_VISIBLE = 0
Visible on both screen and paper.
DISPLAY_HIDDEN = 1
Hidden on both screen and paper.
DISPLAY_NOVIEW = 2
Hidden on screen, visible on paper.
DISPLAY_NOPRINT = 3
Hidden on paper, visible on screen.
Orientations enumeration
Orientation of the contents in the form item.
The Orientations enumeration has the following constants of type int.
ORIENT_NORTH = 0
Orient contents to the top of the form item.
ORIENT_WEST = 1
Orient contents to the left of the form item.
ORIENT_SOUTH = 2
Orient contents to the bottom of the form item.
ORIENT_EAST = 3
Orient contents to the right of the form item.
actionActivate attribute
The action to run on the activate action. This should be a tag of type fTag-TYPE_PDF_ACTION.
actionActivate
Access
read-write
Returns
fPDFAction
alignment attribute
The alignment of the text in the form item. Valid values are in fPDFFormItem-AlignmentTypes.
alignment
Access
read-write
Returns
int
backgroundColor attribute
The background color of the form item. This can only be RGB or CMYK solid colors.
backgroundColor
Access
read-write
Returns
fColor
borderColor attribute
The border color of the form item. This can only be RGB or CMYK solid colors.
borderColor
Access
read-write
Returns
fColor
borderStyle attribute
The border style of the form item. Valid values are in fPDFFormItem-BorderStyles.
borderStyle
Access
read-write
Returns
int
calculationOrder attribute
If the form item has a "calculate" action set, this specifies the order this form item should be calculated relative to the other form items, with lower number being calculated before higher numbers.
calculationOrder
Access
read-write
Returns
int
display attribute
Whether the form item should be visible on screen or paper. Valid values are in fPDFFormItem-DisplayModes.
display
Access
read-write
Returns
int
exportable attribute
If true, this form item will be submitted on a SubmitForm action.
exportable
Access
read-write
Returns
boolean
fillColor attribute
The fill color of the form item. This can only be RGB or CMYK solid colors.
fillColor
Access
read-write
Returns
fColor
font attribute
The name of the font to use for text in the form item. PseudoFonts are not supported. This property will be ignored for fPDFFormCheckbox and fPDFFormRadiobox for items.
font
Access
read-write
Returns
String
fontHeight attribute
The height of the text. If it is set to 0, the text will automatically be sized to fit the form item.
fontHeight
Access
read-write
Returns
fLength
lineWidth attribute
The width of the border.
lineWidth
Access
read-write
Returns
fLength
locked attribute
If true, this form item can not be edited in Acrobat.
locked
Access
read-write
Returns
boolean
orientate attribute
The orientation of the contents of the form item. Valid values are in fPDFFormItem-Orientations.
orientate
Access
read-write
Returns
int
pdfLayer attribute
The PDF Layer to place the form item on.
pdfLayer
Access
read-write
Returns
fPDFLayer
pdfName attribute
The name of the form item to use when creating it in the PDF. If the name is in the form 'a.b', the item will be created in a group with the name 'a'
pdfName
Access
read-write
Returns
String
readonly attribute
If true, the form item does not allow input.
readonly
Access
read-write
Returns
boolean
required attribute
If true, the form item must contain a value when it is submitted.
required
Access
read-write
Returns
boolean
strokeColor attribute
The stroke color of the form item. This can only be RGB or CMYK solid colors.
strokeColor
Access
read-write
Returns
fColor
tabOrder attribute
The tab order of the form item relative to other items, with lower numbers being selected before higher numbers.
tabOrder
Access
read-write
Returns
int
tooltip attribute
The text visible in the form item's tooltip and to be used by screen readers.
tooltip
Access
read-write
Returns
String