Field

Triggered when field is recalculated due to a change in another field

Triggered before a field value is displayed.

Triggered when user modifies text, or selection, in a text, combo or list field

Triggered when a field value is changed

Interactive forms support the following field types: - Button fields represent interactive controls on the screen that the user can manipulate with the mouse. They include pushbuttons, check-boxes, and radio buttons. - Text fields are boxes or spaces in which the user can enter text from the keyboard. - Choice fields contain several text items, at most one of which may be selected as the field value. They include scrollable list boxes and combo boxes. - Signature fields represent electronic 'signatures' for authenticating the identity of a user and the validity of the document's contents.

The Constant e_centered.

The Constant e_check.

The Constant e_choice.

The Constant e_comb.

The Constant e_combo.

The Constant e_commit_on_sel_change.

The Constant e_edit.

The Constant e_file_select.

The Constant e_left_justified.

The Constant e_multiline.

The Constant e_multiselect.

The Constant e_no_export.

The Constant e_no_scroll.

The Constant e_no_spellcheck.

The Constant e_null.

The Constant e_password.

The Constant e_pushbutton_flag.

The Constant e_radio.

The Constant e_radio_flag.

The Constant e_radios_in_unison.

Flags specifying various characteristics of the fields. Field flags common to all field types: ---------------------------------------------- - If e_read_only flag is set the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database. - If e_required flag is set, the field must have a value at the time it is exported by a submit-form action. - If e_no_export flag is set, the field must not be exported by a submit-form action. Field flags specific to radio buttons: ---------------------------------------------- - If e_toggle_to_off is clear, exactly one radio button must be selected at all times; clicking the currently selected button has no effect. If set, clicking the selected button deselects it, leaving no button selected. - If e_radios_in_unison is set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive (the same behavior as HTML radio buttons). Field flags specific to text fields: ---------------------------------------------- - If e_multiline is set, the field can contain multiple lines of text; if clear, the field's text is restricted to a single line. - If e_password If set, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters. The value is not stored if this flag is set. - If e_file_select is set, the text entered in the field represents the pathname of a file whose contents are to be submitted as the value of the field. - If e_no_spellcheck is set, text entered in the field is not spell-checked. - If e_no_scroll is set, the field does not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text is accepted. - If e_comb is set, the field is automatically divided into as many equally spaced positions, or combs, as the value of MaxLen, and the text is laid out into those combs. Meaningful only if the MaxLen entry is present in the text field and if the Multiline, Password, and FileSelect flags are clear. - If e_rich_text is set, the value of this field should be represented as a rich text string. If the field has a value, the RV entry of the field dictionary specifies the rich text string. Field flags specific to choice fields: ---------------------------------------------- - If e_combo is set, the field is a combo box; if clear, the field is a list box. - If e_edit is set, the combo box includes an editable text box as well as a dropdown list; if clear, it includes only a drop-down list. This flag is meaningful only if the e_combo flag is set. - If e_sort is set, the field's option items should be sorted alphabetically. This flag is intended for use by form authoring tools, not by PDF viewer applications. Viewers should simply display the options in the order in which they occur in the Opt array. - If e_multiselect is set, more than one of the field's option items may be selected simultaneously; if clear, no more than one item at a time may be selected. - If e_commit_on_sel_change is set, the new value is committed as soon as a selection is made with the pointing device. This option enables applications to perform an action once a selection is made, without requiring the user to exit the field. If clear, the new value is not committed until the user exits the field.

The Constant e_required.

The Constant e_rich_text.

The Constant e_right_justified.

The Constant e_signature.

The Constant e_sort.

The Constant e_text.

The Constant e_toggle_to_off.

Construct a Field from a SDF dictionary representing a terminal field node.

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

Removes any appearances associated with the field.

Some of the Field attributes are designated as inheritable. If such an attribute is omitted from a Field object, its value is inherited from an ancestor node in the Field tree. If the attribute is a required one, a value must be supplied in an ancestor node; if it is optional and no inherited value is specified, the default value should be used. The function walks up the Field inheritance tree in search for specified attribute.

Flatten/Merge existing form field appearances with the page content and remove widget annotation. Form 'flattening' refers to the operation that changes active form fields into a static area that is part of the PDF document, just like the other text and images in the document. A completely flattened PDF form does not have any widget annotations or interactive fields.

Note: an alternative approach to set the field as read only is using Field.SetFlag(Field::e_read_only, true) method. Unlike Field.SetFlag(...), the result of Flatten() operation can not be programatically reversed.

Get the default graphics state that should be used in formatting the text. The state corresponds to /DA entry in the field dictionary.

Get the default value.

Get the default value as string.

Get the value of the given flag.

Get the quadding (justification).

Get the maximum length

Note: This method is specific to a text field.

Get the field name

Get name of the option specified by the given index.

Note: The index must be less than the value returned by GetOptCount().

Get the number of options.

Get the partial name.

Get the SDFObj.

Get the Action associated with the selected Field Trigger event.

Get the field type.

Return the rectangle that should be refreshed after changing a field.

Get the field value.

Get the value as boolean.

Get the value as string.

Check if current field is an Annotation

Returns whether modifying this field would invalidate a digital signature in the document.

Checks if current field is valid.

Regenerates the appearance stream for the Widget Annotation containing variable text. Call this method if you modified field's value and would like to update field's appearance.

Note: If this field contains text, and has been added to a rotated page, the text in the field may be rotated. If RefreshAppearance is called *after* the field is added to a rotated page, then any text will be rotated in the opposite direction of the page rotation. If this method is called *before* the field is added to any rotated page, then no counter rotation will be applied. If you wish to call RefreshAppearance on a field already added to a rotated page, but you don't want the text to be rotated, you can do one of the following; temporarily un-rotate the page, or, temporarily remove the "P" object from the field.

Modify the field name.

Set the value of given field flag.

Note: You can use this method to set the field as read-only. An alternative approach to set the field as read only is using Page.Flatten(...) method. Unlike Flatten(...), the result of SetFlag(...) can be programatically reversed.

Set the justification to be used in displaying the text field.

Set the maximum length of the field's text, in characters.

Note: This method is specific to a text field.

Set the value of the Field (i.e. the value of the field's /V key). The format of field's value varies depending on the field type.

Note: in order to remove/erase the existing value use pass a SDF::Null object to SetValue().

Note: In PDF, Field's value is separate from its annotation (i.e. how the field appears on the page). After you modify Field's value you need to refresh Field's appearance using RefreshAppearance() method. Alternatively, you can delete "AP" entry from the Widget annotation and set "NeedAppearances" flag in AcroForm dictionary (i.e. doc.GetAcroForm().Put("NeedAppearances", Obj.CreateBool(true)); ) This will force viewer application to auto-generate new field appearances every time the document is opened. Yet another option is to generate a custom annotation appearance using ElementBuilder and ElementWriter and then set the "AP" entry in the widget dictionary to the new appearance stream. This functionality is useful in applications that need advanced control over how the form fields are rendered.

Set the string value.

Set the boolean value.

Sets the signature handler to use for adding a signature to this field. If the signature handler is not found in PDFDoc's signature handlers list, this field will not be signed. To add signature handlers, use PDFDoc.addSignatureHandler method. If a signature handler is already assigned to this field and this method is called once again, the associate signature handler for this field will be updated with the new handler.