Click or drag to resize
Pdftools logo

ComboBox Class

A combo box field

Inheritance Hierarchy
SystemObject
  PdfTools.Toolbox.InternalNativeBase
    PdfTools.Toolbox.InternalNativeObject
      PdfTools.Toolbox.Pdf.FormsFieldNode
        PdfTools.Toolbox.Pdf.FormsField
          PdfTools.Toolbox.Pdf.FormsChoiceField
            PdfTools.Toolbox.Pdf.FormsComboBox

Namespace: PdfTools.Toolbox.Pdf.Forms
Assembly: PdfTools.Toolbox (in PdfTools.Toolbox.dll) Version: 1.1.0+5820e9ca9ca173983539ffc40abc227fb62e6928
Syntax
C#
public class ComboBox : ChoiceField

The ComboBox type exposes the following members.

Properties
 NameDescription
Public propertyCanEdit

Has an editable item

Public propertyChosenItem

The selected combo box item

If this property is then the EditableItemName is the selected value. Setting this property automatically sets EditableItemName to .
Public propertyDisplayName

User interface name

The display name is not directly visible, but a PDF viewer can display this name, e.g., in a tool tip.
(Inherited from FieldNode)
Public propertyDoNotExport

Tells whether this field is exported


(Inherited from Field)
Public propertyEditableItemName

The name of the editable item

This property is if any of the combo box items is selected, i.e., if ChosenItem is not . Setting this property automatically sets ChosenItem to .
Public propertyExportName

The name used when exporting


(Inherited from FieldNode)
Public propertyItems

The list of choice items

Adding or removing items or clearing the list is not supported.
(Inherited from ChoiceField)
Public propertyReadOnly

Flags this field as read-only


(Inherited from Field)
Public propertyRequired

Flags this field as mandatory


(Inherited from Field)
Public propertyWidgets

This form field's widget annotations


(Inherited from Field)
Top
Methods
 NameDescription
Public methodAddNewItem Creates a new choice item. The item is automatically added to the choice field's Items.
(Inherited from ChoiceField)
Public methodAddNewWidget

Create a new widget and add to the form field

This method creates a widget for the form field. The widget is automatically added to the field's widgets, but not to any page. This method does not work for radio button form fields; Use AddNewWidget(Rectangle).
(Inherited from Field)
Public methodStatic memberCreate

Create a combo box form field

The returned form field object is not yet used, but it is associated with the given target document.
Public methodEquals
(Inherited from NativeObject)
Public methodGetHashCode
(Inherited from NativeObject)
Top
See Also