Skip to main content
A newer version of this page is available. .
.NET Framework 4.5.2+

PdfInteractiveFormFieldFlags Enum

Represents flags specifying various document-level characteristics related to interactive form fields.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v19.2.Core.dll

Declaration

[Flags]
public enum PdfInteractiveFormFieldFlags

Members

Name Description
None

If active, deactivates all other options.

ReadOnly

If this flag is set, the end user may not change the value of the field. Any associated widget annotations will not interact with the end user. This flag is useful for fields whose values are computed or imported from a database.

Required

If this flag is set, the field shall have a value at the time it is exported by a submit-form action.

NoExport

If this flag is set, the field shall not be exported by a submit-form action.

Multiline

If this flag is set, the field may contain multiple lines of text. Otherwise, the field’s text shall be restricted to a single line.

Password

If this flag is set, the field is intended for entering a secure password that should not be echoed visibly on the screen. Characters typed from the keyboard shall instead be echoed in an unreadable form, such as asterisks or bullet characters.

NoToggleToOff

This flag is used for radio buttons only. If active, exactly one radio button shall be selected at all times; selecting the currently selected button has no effect. Otherwise, clicking the selected button deselects it, leaving no button selected.

Radio

If this flag is set, the field is a set of radio buttons. Otherwise, the field is a check box. This flag may be set only if the PdfInteractiveFormFieldFlags.PushButton flag is clear.

PushButton

If this flag is set, the field is a pushbutton that does not retain a permanent value.

Combo

If this flag is active, the field is a combo box. Otherwise, the field is a list box.

Edit

If this flag is set, the combo box shall include an editable text box as well as a drop-down list. Otherwise, the combo box shall include only a drop-down list. This flag shall be used only if the PdfInteractiveFormFieldFlags.Combo flag is set.

Sort

If the flag is set, the field’s option items shall be sorted alphabetically.

FileSelect

If this flag is set, the text entered in the field represents the pathname of a file whose contents shall be submitted as the value of the field.

MultiSelect

If this flag is set, more than one of the field’s option items may be selected simultaneously. Otherwise, only one item shall be selected.

DoNotSpellCheck

If this flag is set, text entered in the field shall not be spell-checked. This flag shall not be used unless the PdfInteractiveFormFieldFlags.Combo and PdfInteractiveFormFieldFlags.Edit flags are both set.

DoNotScroll

If this flag is set, the field shall not scroll to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text shall be accepted for interactive form filling.

Comb

This flag is set only if the PdfTextFormField.MaxLen entry is present in the text field dictionary and if the PdfInteractiveFormFieldFlags.Multiline, PdfInteractiveFormFieldFlags.Password, and PdfInteractiveFormFieldFlags.FileSelect flags are clear. If this flag is active, the field shall be automatically divided into as many equally spaced positions, or combs, as the value of MaxLen, and the text is laid out into those combs.

RichText

If this flag is set, the value of this field shall be a rich text string.

RadiosInUnison

If this flag 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. Otherwise, the buttons are mutually exclusive.

CommitOnSelChange

If the flag is set, the new value shall be committed once a selection is made. Otherwise, the new value is not committed until the end user exits the field.

Remarks

Values listed by this enumeration are returned by the PdfInteractiveFormField.Flags property.

See Also