Skip to content

FormElement interface

The FormElement interface represents a single form control for a given page. FormElements are currently supported for static PDF documents.

FormElement::Action property

The Action property contains the behavior when a user clicks the form element.

FormElement::ActionDest property

The ActionDest property contains the destination when a user interacts with certain form controls.

FormElement::Alignment property

The Alignment property contains the text alignment that a viewer should use when presenting a single or multiline edit control.

FormElement::Caption property

The Caption property returns the optional text associated with a check box or radio button.

FormElement::ElementType property

The ElementType property contains the control type that a viewer should use to collect input from a user.

FormElement::Flags property

The Flags property contains a bit set of flags applicable to the control.

FormElement::FontName property

The FontName property contains the font that a viewer should use when presenting a single or multiline edit control.

FormElement::FontSize property

The FontSize property contains the font size that a viewer should use when presenting a single or multiline edit control.

FormElement::GetOption method

The GetOption method returns a FormElementOption object that represents a single selectable option in a list box or dropdown box.

FormElement::Height property

The Height property return the dimensions on the page where the form element should be positioned. The dimension information is based on the DPI used when loading the page.

FormElement::Name property

The Name property returns the qualified name for the form element.

FormElement::OptionCount property

The OptionCount property contains the number of items that are available in list boxes and dropdown boxes.

FormElement::Rotation property

The Rotation property contains the rotation in degrees of the form element. Only rotation in 90 degree increments will be returned.

FormElement::Selected property

The Selected property contains the current selected item in a single-select list box, or drop down box.

FormElement::Value property

The Value property returns the stored value for the form element.

FormElement::Width property

The Width property return the dimensions on the page where the form element should be positioned. The dimension information is based on the DPI used when loading the page.

FormElement::X property

The X property return the position on the page where the user should be scrolled to. The position information is based on the DPI used when loading the page.

FormElement::Y property

The Y property return the position on the page where the user should be scrolled to. The position information is based on the DPI used when loading the page.