Click or drag to resize

PdfChoiceField Class

Represents a base class for choice fields, such as PdfListBoxField and PdfDropdownField, that contain several text items, at most one of which may be selected as the field value.
Inheritance Hierarchy
SystemObject
  SautinSoft.PdfPdfObject
    SautinSoft.Pdf.AnnotationsPdfAnnotation
      SautinSoft.Pdf.FormsPdfField
        SautinSoft.Pdf.FormsPdfVariableTextField
          SautinSoft.Pdf.FormsPdfChoiceField
            SautinSoft.Pdf.FormsPdfDropdownField
            SautinSoft.Pdf.FormsPdfListBoxField

Namespace: SautinSoft.Pdf.Forms
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2025.5.21
Syntax
Copy
public abstract class PdfChoiceField : PdfVariableTextField

The PdfChoiceField type exposes the following members.

Properties
 NameDescription
Public propertyCommitSelectedValueImmediately

(PDF 1.5) If set to , the new value shall be committed as soon as a selection is made (commonly with the pointing device). In this case, supplying a value for a field involves three actions: selecting the field for fill-in, selecting a choice for the fill-in value, and leaving that field, which finalizes or "commits" the data choice and triggers any actions associated with the entry or changing of this data. If this property is , then processing does not wait for leaving the field action to occur, but immediately proceeds to the third step.

This property enables applications to perform an action once a selection is made, without requiring the user to exit the field. If , the new value is not committed until the user exits the field.

Public propertyItems Gets the items of this PdfChoiceField.
Public propertySelectedIndex Gets or sets the index of the selected item or -1 if no item is selected.
Public propertySelectedItem Gets or sets the selected item or if no item is selected.
Top
Extension Methods
 NameDescription
Public Extension MethodGetArray Gets the PdfArray that serves as a backing storage of the specified PdfObject or if no PdfArray serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetOrAddDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Top
See Also