An AcroForm field type representing any type of choice field. More...

Inheritance diagram for iText.Forms.Fields.PdfChoiceFormField:

Public Member Functions
override PdfName	GetFormType ()
	Returns `Ch`, the form type for choice form fields. More...

virtual iText.Forms.Fields.PdfChoiceFormField	SetTopIndex (int index)
	Sets the index of the first visible option in a scrollable list. More...

virtual PdfNumber	GetTopIndex ()
	Gets the current index of the first option in a scrollable list. More...

virtual iText.Forms.Fields.PdfChoiceFormField	SetIndices (PdfArray indices)
	Sets the selected items in the field. More...

virtual iText.Forms.Fields.PdfChoiceFormField	SetListSelected (String[] optionValues)
	Highlights the options. More...

virtual iText.Forms.Fields.PdfChoiceFormField	SetListSelected (int[] optionNumbers)
	Highlights the options. More...

virtual PdfArray	GetIndices ()
	Gets the currently selected items in the field More...

virtual iText.Forms.Fields.PdfChoiceFormField	SetCombo (bool combo)
	If true, the field is a combo box; if false, the field is a list box. More...

virtual bool	IsCombo ()
	If true, the field is a combo box; if false, the field is a list box. More...

virtual iText.Forms.Fields.PdfChoiceFormField	SetEdit (bool edit)
	If true, the combo box shall include an editable text box as well as a drop-down list; if false, it shall include only a drop-down list. More...

virtual bool	IsEdit ()
	If true, the combo box shall include an editable text box as well as a drop-down list; if false, it shall include only a drop-down list. More...

virtual iText.Forms.Fields.PdfChoiceFormField	SetSort (bool sort)
	If true, the field's option items shall be sorted alphabetically. More...

virtual bool	IsSort ()
	If true, the field's option items shall be sorted alphabetically. More...

virtual iText.Forms.Fields.PdfChoiceFormField	SetMultiSelect (bool multiSelect)
	If true, more than one of the field's option items may be selected simultaneously; if false, at most one item shall be selected. More...

virtual bool	IsMultiSelect ()
	If true, more than one of the field's option items may be selected simultaneously; if false, at most one item shall be selected. More...

virtual iText.Forms.Fields.PdfChoiceFormField	SetSpellCheck (bool spellCheck)
	If true, text entered in the field shall be spell-checked.. More...

virtual bool	IsSpellCheck ()
	If true, text entered in the field shall be spell-checked.. More...

virtual iText.Forms.Fields.PdfChoiceFormField	SetCommitOnSelChange (bool commitOnSelChange)
	If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device). More...

virtual bool	IsCommitOnSelChange ()
	If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device). More...

Public Member Functions inherited from iText.Forms.Fields.PdfFormField
	PdfFormField (PdfDictionary pdfObject)
	Creates a form field as a wrapper object around a iText.Kernel.Pdf.PdfDictionary. More...

virtual iText.Forms.Fields.PdfFormField	SetValue (String value)
	Sets a value to the field and generating field appearance if needed. More...

virtual iText.Forms.Fields.PdfFormField	SetValue (String value, bool generateAppearance)
	Sets a value to the field and generating field appearance if needed. More...

virtual iText.Forms.Fields.PdfFormField	SetValue (String value, PdfFont font, float fontSize)
	Set text field value with given font and size More...

virtual iText.Forms.Fields.PdfFormField	SetValue (String value, String display)
	Sets the field value and the display string. More...

virtual iText.Forms.Fields.PdfFormField	SetParent (iText.Forms.Fields.PdfFormField parent)
	Sets a parent PdfFormField for the current object. More...

virtual PdfDictionary	GetParent ()
	Gets the parent dictionary. More...

virtual PdfArray	GetKids ()
	Gets the kids of this object. More...

virtual iText.Forms.Fields.PdfFormField	AddKid (iText.Forms.Fields.PdfFormField kid)
	Adds a new kid to the `Kids` array property from a PdfFormField. More...

virtual iText.Forms.Fields.PdfFormField	AddKid (PdfWidgetAnnotation kid)
	Adds a new kid to the `Kids` array property from a iText.Kernel.Pdf.Annot.PdfWidgetAnnotation. More...

virtual iText.Forms.Fields.PdfFormField	SetFieldName (String name)
	Changes the name of the field to the specified value. More...

virtual PdfString	GetFieldName ()
	Gets the current field name. More...

virtual iText.Forms.Fields.PdfFormField	SetAlternativeName (String name)
	Changes the alternate name of the field to the specified value. More...

virtual PdfString	GetAlternativeName ()
	Gets the current alternate name. More...

virtual iText.Forms.Fields.PdfFormField	SetMappingName (String name)
	Changes the mapping name of the field to the specified value. More...

virtual PdfString	GetMappingName ()
	Gets the current mapping name. More...

virtual bool	GetFieldFlag (int flag)
	Checks whether a certain flag, or any of a combination of flags, is set for this form field. More...

virtual iText.Forms.Fields.PdfFormField	SetFieldFlag (int flag)
	Adds a flag, or combination of flags, for the form field. More...

virtual iText.Forms.Fields.PdfFormField	SetFieldFlag (int flag, bool value)
	Adds or removes a flag, or combination of flags, for the form field. More...

virtual bool	IsMultiline ()
	If true, the field can contain multiple lines of text; if false, the field's text is restricted to a single line. More...

virtual bool	IsPassword ()
	If true, the field is intended for entering a secure password that should not be echoed visibly to the screen. More...

virtual iText.Forms.Fields.PdfFormField	SetFieldFlags (int flags)
	Sets a flag, or combination of flags, for the form field. More...

virtual int	GetFieldFlags ()
	Gets the current list of PDF form field flags. More...

virtual PdfObject	GetValue ()
	Gets the current value contained in the form field. More...

virtual String	GetValueAsString ()
	Gets the current value contained in the form field. More...

virtual iText.Forms.Fields.PdfFormField	SetDefaultValue (PdfObject value)
	Sets the default fallback value for the form field. More...

virtual PdfObject	GetDefaultValue ()
	Gets the default fallback value for the form field. More...

virtual iText.Forms.Fields.PdfFormField	SetAdditionalAction (PdfName key, PdfAction action)
	Sets an additional action for the form field. More...

virtual PdfDictionary	GetAdditionalAction ()
	Gets the currently additional action dictionary for the form field. More...

virtual iText.Forms.Fields.PdfFormField	SetOptions (PdfArray options)
	Sets options for the form field. More...

virtual PdfArray	GetOptions ()
	Gets options for the form field. More...

virtual IList< PdfWidgetAnnotation >	GetWidgets ()
	Gets all iText.Kernel.Pdf.Annot.PdfWidgetAnnotation that this form field and its kids refer to. More...

virtual PdfString	GetDefaultAppearance ()
	Gets default appearance string containing a sequence of valid page-content graphics or text state operators that define such properties as the field's text size and color. More...

virtual iText.Forms.Fields.PdfFormField	SetDefaultAppearance (String defaultAppearance)
	Sets default appearance string containing a sequence of valid page-content graphics or text state operators that define such properties as the field's text size and color. More...

virtual void	UpdateDefaultAppearance ()
	Updates DA for Variable text, Push button and choice form fields. More...

virtual ? int	GetJustification ()
	Gets a code specifying the form of quadding (justification) to be used in displaying the text: 0 Left-justified 1 Centered 2 Right-justified More...

virtual iText.Forms.Fields.PdfFormField	SetJustification (int justification)
	Sets a code specifying the form of quadding (justification) to be used in displaying the text: 0 Left-justified 1 Centered 2 Right-justified More...

virtual PdfString	GetDefaultStyle ()
	Gets a default style string, as described in "Rich Text Strings" section of Pdf spec. More...

virtual iText.Forms.Fields.PdfFormField	SetDefaultStyle (PdfString defaultStyleString)
	Sets a default style string, as described in "Rich Text Strings" section of Pdf spec. More...

virtual PdfObject	GetRichText ()
	Gets a rich text string, as described in "Rich Text Strings" section of Pdf spec. More...

virtual iText.Forms.Fields.PdfFormField	SetRichText (PdfObject richText)
	Sets a rich text string, as described in "Rich Text Strings" section of Pdf spec. More...

virtual float	GetFontSize ()
	Gets the current fontSize of the form field. More...

virtual PdfFont	GetFont ()
	Gets the current font of the form field. More...

virtual Color	GetColor ()
	Gets the current color of the form field. More...

virtual iText.Forms.Fields.PdfFormField	SetFont (PdfFont font)
	Basic setter for the `font` property. More...

virtual iText.Forms.Fields.PdfFormField	SetFontSize (float fontSize)
	Basic setter for the `fontSize` property. More...

virtual iText.Forms.Fields.PdfFormField	SetFontSize (int fontSize)
	Basic setter for the `fontSize` property. More...

virtual iText.Forms.Fields.PdfFormField	SetFontAndSize (PdfFont font, int fontSize)
	Combined setter for the `font` and `fontSize` properties. More...

virtual iText.Forms.Fields.PdfFormField	SetFontAndSize (PdfFont font, float fontSize)
	Combined setter for the `font` and `fontSize` properties. More...

virtual iText.Forms.Fields.PdfFormField	SetBackgroundColor (Color backgroundColor)
	Basic setter for the `backgroundColor` property. More...

virtual iText.Forms.Fields.PdfFormField	SetRotation (int degRotation)
	Basic setter for the `degRotation` property. More...

virtual iText.Forms.Fields.PdfFormField	SetAction (PdfAction action)
	Sets the action on all widgets of this form field. More...

virtual iText.Forms.Fields.PdfFormField	SetCheckType (int checkType)
	Changes the type of graphical marker used to mark a checkbox as 'on'. More...

virtual iText.Forms.Fields.PdfFormField	SetVisibility (int visibility)
	Set the visibility flags of the form field annotation Options are: HIDDEN, HIDDEN_BUT_PRINTABLE, VISIBLE, VISIBLE_BUT_DOES_NOT_PRINT More...

virtual bool	RegenerateField ()
	This method regenerates appearance stream of the field. More...

virtual float	GetBorderWidth ()
	Gets the border width for the field. More...

virtual iText.Forms.Fields.PdfFormField	SetBorderWidth (float borderWidth)
	Sets the border width for the field. More...

virtual iText.Forms.Fields.PdfFormField	SetBorderStyle (PdfDictionary style)

virtual iText.Forms.Fields.PdfFormField	SetBorderColor (Color color)
	Sets the Border Color. More...

virtual iText.Forms.Fields.PdfFormField	SetColor (Color color)
	Sets the text color. More...

virtual iText.Forms.Fields.PdfFormField	SetReadOnly (bool readOnly)
	Sets the ReadOnly flag, specifying whether or not the field can be changed. More...

virtual bool	IsReadOnly ()
	Gets the ReadOnly flag, specifying whether or not the field can be changed. More...

virtual iText.Forms.Fields.PdfFormField	SetRequired (bool required)
	Sets the Required flag, specifying whether or not the field must be filled in. More...

virtual bool	IsRequired ()
	Gets the Required flag, specifying whether or not the field must be filled in. More...

virtual iText.Forms.Fields.PdfFormField	SetNoExport (bool noExport)
	Sets the NoExport flag, specifying whether or not exporting is forbidden. More...

virtual bool	IsNoExport ()
	Gets the NoExport attribute. More...

virtual iText.Forms.Fields.PdfFormField	SetPage (int pageNum)
	Specifies on which page the form field's widget must be shown. More...

virtual String[]	GetAppearanceStates ()
	Gets the appearance state names. More...

virtual iText.Forms.Fields.PdfFormField	SetAppearance (PdfName appearanceType, String appearanceState, PdfStream appearanceStream)
	Sets an appearance for (the widgets related to) the form field. More...

virtual iText.Forms.Fields.PdfFormField	SetFontSizeAutoScale ()
	Sets zero font size which will be interpreted as auto-size according to ISO 32000-1, 12.7.3.3. More...

virtual iText.Forms.Fields.PdfFormField	Put (PdfName key, PdfObject value)

virtual void	Release ()
	Releases underlying pdf object and other pdf entities used by wrapper. More...

Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T	GetPdfObject ()

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document, PdfIndirectReference reference)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	SetModified ()

virtual void	Flush ()

virtual bool	IsFlushed ()

Static Public Attributes
static readonly int	FF_COMBO = MakeFieldFlag(18)
	Choice field flags More...

static readonly int	FF_EDIT = MakeFieldFlag(19)

static readonly int	FF_SORT = MakeFieldFlag(20)

static readonly int	FF_MULTI_SELECT = MakeFieldFlag(22)

static readonly int	FF_DO_NOT_SPELL_CHECK = MakeFieldFlag(23)

static readonly int	FF_COMMIT_ON_SEL_CHANGE = MakeFieldFlag(27)

Static Public Attributes inherited from iText.Forms.Fields.PdfFormField
static readonly int	FF_MULTILINE = MakeFieldFlag(13)
	Flag that designates, if set, that the field can contain multiple lines of text. More...

static readonly int	FF_PASSWORD = MakeFieldFlag(14)
	Flag that designates, if set, that the field's contents must be obfuscated. More...

const int	DEFAULT_FONT_SIZE = 12
	Size of text in form fields when font size is not explicitly set. More...

const int	MIN_FONT_SIZE = 4

const int	DA_FONT = 0

const int	DA_SIZE = 1

const int	DA_COLOR = 2

const int	ALIGN_LEFT = 0

const int	ALIGN_CENTER = 1

const int	ALIGN_RIGHT = 2

const int	TYPE_CHECK = 1
	A field with the symbol check More...

const int	TYPE_CIRCLE = 2
	A field with the symbol circle More...

const int	TYPE_CROSS = 3
	A field with the symbol cross More...

const int	TYPE_DIAMOND = 4
	A field with the symbol diamond More...

const int	TYPE_SQUARE = 5
	A field with the symbol square More...

const int	TYPE_STAR = 6
	A field with the symbol star More...

const int	HIDDEN = 1

const int	VISIBLE_BUT_DOES_NOT_PRINT = 2

const int	HIDDEN_BUT_PRINTABLE = 3

const int	VISIBLE = 4

static readonly int	FF_READ_ONLY = MakeFieldFlag(1)

static readonly int	FF_REQUIRED = MakeFieldFlag(2)

static readonly int	FF_NO_EXPORT = MakeFieldFlag(3)

const float	X_OFFSET = 2

Additional Inherited Members
Static Public Member Functions inherited from iText.Forms.Fields.PdfFormField
static int	MakeFieldFlag (int bitPosition)
	Makes a field flag by bit position. More...

static iText.Forms.Fields.PdfFormField	CreateEmptyField (PdfDocument doc)
	Creates an empty form field without a predefined set of layout or behavior. More...

static iText.Forms.Fields.PdfFormField	CreateEmptyField (PdfDocument doc, PdfAConformanceLevel pdfAConformanceLevel)
	Creates an empty form field without a predefined set of layout or behavior. More...

static PdfButtonFormField	CreateButton (PdfDocument doc, Rectangle rect, int flags)
	Creates an empty button form field with custom behavior and layout, on a specified location. More...

static PdfButtonFormField	CreateButton (PdfDocument doc, Rectangle rect, int flags, PdfAConformanceLevel pdfAConformanceLevel)
	Creates an empty button form field with custom behavior and layout, on a specified location. More...

static PdfButtonFormField	CreateButton (PdfDocument doc, int flags)
	Creates an empty button form field with custom behavior and layout. More...

static PdfButtonFormField	CreateButton (PdfDocument doc, int flags, PdfAConformanceLevel pdfAConformanceLevel)
	Creates an empty button form field with custom behavior and layout. More...

static PdfTextFormField	CreateText (PdfDocument doc)
	Creates an empty text form field. More...

static PdfTextFormField	CreateText (PdfDocument doc, PdfAConformanceLevel pdfAConformanceLevel)
	Creates an empty text form field. More...

static PdfTextFormField	CreateText (PdfDocument doc, Rectangle rect)
	Creates an empty text form field. More...

static PdfTextFormField	CreateText (PdfDocument doc, Rectangle rect, String name)
	Creates a named text form field with an initial value, and the form's default font specified in iText.Forms.PdfAcroForm.GetDefaultResources(). More...

static PdfTextFormField	CreateText (PdfDocument doc, Rectangle rect, String name, String value)
	Creates a named text form field with an initial value, and the form's default font specified in iText.Forms.PdfAcroForm.GetDefaultResources(). More...

static PdfTextFormField	CreateText (PdfDocument doc, Rectangle rect, String name, String value, PdfFont font, float fontSize)
	Creates a named text form field with an initial value, with a specified font and font size. More...

static PdfTextFormField	CreateText (PdfDocument doc, Rectangle rect, String name, String value, PdfFont font, float fontSize, bool multiline)
	Creates a named text form field with an initial value, with a specified font and font size. More...

static PdfTextFormField	CreateText (PdfDocument doc, Rectangle rect, String name, String value, PdfFont font, float fontSize, bool multiline, PdfAConformanceLevel pdfAConformanceLevel)
	Creates a named text form field with an initial value, with a specified font and font size. More...

static PdfTextFormField	CreateMultilineText (PdfDocument doc, Rectangle rect, String name, String value, PdfFont font, float fontSize)
	Creates a named multilined text form field with an initial value, with a specified font and font size. More...

static PdfTextFormField	CreateMultilineText (PdfDocument doc, Rectangle rect, String name, String value)
	Creates a named multiline text form field with an initial value, and the form's default font specified in iText.Forms.PdfAcroForm.GetDefaultResources(). More...

static PdfChoiceFormField	CreateChoice (PdfDocument doc, int flags)
	Creates an empty choice form field. More...

static PdfChoiceFormField	CreateChoice (PdfDocument doc, int flags, PdfAConformanceLevel pdfAConformanceLevel)
	Creates an empty choice form field. More...

static PdfChoiceFormField	CreateChoice (PdfDocument doc, Rectangle rect, int flags)
	Creates an empty choice form field with custom behavior and layout, on a specified location. More...

static PdfChoiceFormField	CreateChoice (PdfDocument doc, Rectangle rect, String name, String value, PdfArray options, int flags)
	Creates a choice form field with custom behavior and layout, on a specified location. More...

static PdfChoiceFormField	CreateChoice (PdfDocument doc, Rectangle rect, String name, String value, PdfArray options, int flags, PdfFont font, PdfAConformanceLevel pdfAConformanceLevel)
	Creates a choice form field with custom behavior and layout, on a specified location. More...

static PdfChoiceFormField	CreateChoice (PdfDocument doc, Rectangle rect, String name, String value, PdfFont font, float fontSize, PdfArray options, int flags)
	Creates a choice form field with custom behavior and layout, on a specified location. More...

static PdfChoiceFormField	CreateChoice (PdfDocument doc, Rectangle rect, String name, String value, PdfFont font, float fontSize, PdfArray options, int flags, PdfAConformanceLevel pdfAConformanceLevel)
	Creates a choice form field with custom behavior and layout, on a specified location. More...

static PdfSignatureFormField	CreateSignature (PdfDocument doc)
	Creates an empty signature form field. More...

static PdfSignatureFormField	CreateSignature (PdfDocument doc, PdfAConformanceLevel pdfAConformanceLevel)
	Creates an empty signature form field. More...

static PdfSignatureFormField	CreateSignature (PdfDocument doc, Rectangle rect)
	Creates an empty signature form field. More...

static PdfSignatureFormField	CreateSignature (PdfDocument doc, Rectangle rect, PdfAConformanceLevel pdfAConformanceLevel)
	Creates an empty signature form field. More...

static PdfButtonFormField	CreateRadioGroup (PdfDocument doc, String name, String value)
	Creates a radio group form field. More...

static PdfButtonFormField	CreateRadioGroup (PdfDocument doc, String name, String value, PdfAConformanceLevel pdfAConformanceLevel)
	Creates a radio group form field. More...

static iText.Forms.Fields.PdfFormField	CreateRadioButton (PdfDocument doc, Rectangle rect, PdfButtonFormField radioGroup, String value)
	Creates a generic PdfFormField that is added to a radio group. More...

static iText.Forms.Fields.PdfFormField	CreateRadioButton (PdfDocument doc, Rectangle rect, PdfButtonFormField radioGroup, String value, PdfAConformanceLevel pdfAConformanceLevel)
	Creates a generic PdfFormField that is added to a radio group. More...

static PdfButtonFormField	CreatePushButton (PdfDocument doc, Rectangle rect, String name, String caption)
	Creates a PdfButtonFormField as a push button without data. More...

static PdfButtonFormField	CreatePushButton (PdfDocument doc, Rectangle rect, String name, String caption, PdfFont font, float fontSize)
	Creates a PdfButtonFormField as a push button without data, with its caption in a custom font. More...

static PdfButtonFormField	CreatePushButton (PdfDocument doc, Rectangle rect, String name, String caption, PdfFont font, float fontSize, PdfAConformanceLevel pdfAConformanceLevel)
	Creates a PdfButtonFormField as a push button without data, with its caption in a custom font. More...

static PdfButtonFormField	CreateCheckBox (PdfDocument doc, Rectangle rect, String name, String value)
	Creates a PdfButtonFormField as a checkbox. More...

static PdfButtonFormField	CreateCheckBox (PdfDocument doc, Rectangle rect, String name, String value, int checkType)
	Creates a PdfButtonFormField as a checkbox. More...

static PdfButtonFormField	CreateCheckBox (PdfDocument doc, Rectangle rect, String name, String value, int checkType, PdfAConformanceLevel pdfAConformanceLevel)
	Creates a PdfButtonFormField as a checkbox. More...

static PdfChoiceFormField	CreateComboBox (PdfDocument doc, Rectangle rect, String name, String value, String[][] options)
	Creates a combobox with custom behavior and layout, on a specified location. More...

static PdfChoiceFormField	CreateComboBox (PdfDocument doc, Rectangle rect, String name, String value, String[][] options, PdfFont font, PdfAConformanceLevel pdfAConformanceLevel)
	Creates a combobox with custom behavior and layout, on a specified location. More...

static PdfChoiceFormField	CreateComboBox (PdfDocument doc, Rectangle rect, String name, String value, String[] options)
	Creates a combobox with custom behavior and layout, on a specified location. More...

static PdfChoiceFormField	CreateComboBox (PdfDocument doc, Rectangle rect, String name, String value, String[] options, PdfFont font, PdfAConformanceLevel pdfAConformanceLevel)
	Creates a combobox with custom behavior and layout, on a specified location. More...

static PdfChoiceFormField	CreateList (PdfDocument doc, Rectangle rect, String name, String value, String[][] options)
	Creates a list field with custom behavior and layout, on a specified location. More...

static PdfChoiceFormField	CreateList (PdfDocument doc, Rectangle rect, String name, String value, String[][] options, PdfFont font, PdfAConformanceLevel pdfAConformanceLevel)
	Creates a list field with custom behavior and layout, on a specified location. More...

static PdfChoiceFormField	CreateList (PdfDocument doc, Rectangle rect, String name, String value, String[] options)
	Creates a list field with custom behavior and layout, on a specified location. More...

static PdfChoiceFormField	CreateList (PdfDocument doc, Rectangle rect, String name, String value, String[] options, PdfFont font, PdfAConformanceLevel pdfAConformanceLevel)
	Creates a list field with custom behavior and layout, on a specified location. More...

static iText.Forms.Fields.PdfFormField	MakeFormField (PdfObject pdfObject, PdfDocument document)
	Creates a (subtype of) PdfFormField object. More...

Protected Member Functions inherited from iText.Forms.Fields.PdfFormField
override bool	IsWrappedObjectMustBeIndirect ()
	Defines if the object behind this wrapper must be an indirect object in the resultant document. More...

Detailed Description

An AcroForm field type representing any type of choice field.

An AcroForm field type representing any type of choice field. Choice fields are to be represented by a viewer as a list box or a combo box.

Member Function Documentation

◆ GetFormType()

override PdfName iText.Forms.Fields.PdfChoiceFormField.GetFormType ( )

inlinevirtual

Returns Ch, the form type for choice form fields.

Returns: the form type, as a iText.Kernel.Pdf.PdfName

Reimplemented from iText.Forms.Fields.PdfFormField.

◆ GetIndices()

virtual PdfArray iText.Forms.Fields.PdfChoiceFormField.GetIndices ( )

inlinevirtual

Gets the currently selected items in the field

Returns: a sorted array of indices representing the currently selected items in the field

◆ GetTopIndex()

virtual PdfNumber iText.Forms.Fields.PdfChoiceFormField.GetTopIndex ( )

inlinevirtual

Gets the current index of the first option in a scrollable list.

Returns: the index of the first option, as a iText.Kernel.Pdf.PdfNumber

◆ IsCombo()

virtual bool iText.Forms.Fields.PdfChoiceFormField.IsCombo ( )

inlinevirtual

If true, the field is a combo box; if false, the field is a list box.

Returns: whether or not the field is now a combo box.

◆ IsCommitOnSelChange()

virtual bool iText.Forms.Fields.PdfChoiceFormField.IsCommitOnSelChange ( )

inlinevirtual

If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device).

Returns: whether or not to save changes immediately

◆ IsEdit()

virtual bool iText.Forms.Fields.PdfChoiceFormField.IsEdit ( )

inlinevirtual

If true, the combo box shall include an editable text box as well as a drop-down list; if false, it shall include only a drop-down list.

If true, the combo box shall include an editable text box as well as a drop-down list; if false, it shall include only a drop-down list. This flag shall be used only if the Combo flag is true.

Returns: whether or not there is currently an editable text box

◆ IsMultiSelect()

virtual bool iText.Forms.Fields.PdfChoiceFormField.IsMultiSelect ( )

inlinevirtual

If true, more than one of the field's option items may be selected simultaneously; if false, at most one item shall be selected.

Returns: whether or not multiple selection is currently allowed

◆ IsSort()

virtual bool iText.Forms.Fields.PdfChoiceFormField.IsSort ( )

inlinevirtual

If true, the field's option items shall be sorted alphabetically.

If true, the field's option items shall be sorted alphabetically. This flag is intended for use by writers, not by readers.

Returns: whether or not the items are currently sorted

◆ IsSpellCheck()

virtual bool iText.Forms.Fields.PdfChoiceFormField.IsSpellCheck ( )

inlinevirtual

If true, text entered in the field shall be spell-checked..

Returns: whether or not PDF viewer must perform a spell check

◆ SetCombo()

virtual iText.Forms.Fields.PdfChoiceFormField iText.Forms.Fields.PdfChoiceFormField.SetCombo ( bool combo )

inlinevirtual

If true, the field is a combo box; if false, the field is a list box.

Parameters

combo whether or not the field should be a combo box

Returns: current PdfChoiceFormField

◆ SetCommitOnSelChange()

virtual iText.Forms.Fields.PdfChoiceFormField iText.Forms.Fields.PdfChoiceFormField.SetCommitOnSelChange ( bool commitOnSelChange )

inlinevirtual

If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device).

Parameters

commitOnSelChange whether or not to save changes immediately

Returns: current PdfChoiceFormField

◆ SetEdit()

virtual iText.Forms.Fields.PdfChoiceFormField iText.Forms.Fields.PdfChoiceFormField.SetEdit ( bool edit )

inlinevirtual

If true, the combo box shall include an editable text box as well as a drop-down list; if false, it shall include only a drop-down list.

If true, the combo box shall include an editable text box as well as a drop-down list; if false, it shall include only a drop-down list. This flag shall be used only if the Combo flag is true.

Parameters

edit	whether or not to add an editable text box

Returns: current PdfChoiceFormField

◆ SetIndices()

virtual iText.Forms.Fields.PdfChoiceFormField iText.Forms.Fields.PdfChoiceFormField.SetIndices ( PdfArray indices )

inlinevirtual

Sets the selected items in the field.

Parameters

indices a sorted array of indices representing selected items in the field

Returns: current PdfChoiceFormField

◆ SetListSelected() [1/2]

virtual iText.Forms.Fields.PdfChoiceFormField iText.Forms.Fields.PdfChoiceFormField.SetListSelected ( int[] optionNumbers )

inlinevirtual

Highlights the options.

Highlights the options. Is this method is used for Combo box, the first value in input array will be the field value

Parameters

optionNumbers The option numbers

Returns: The edited PdfChoiceFormField

◆ SetListSelected() [2/2]

virtual iText.Forms.Fields.PdfChoiceFormField iText.Forms.Fields.PdfChoiceFormField.SetListSelected ( String[] optionValues )

inlinevirtual

Highlights the options.

Highlights the options. If this method is used for Combo box, the first value in input array will be the field value

Parameters

optionValues Array of options to be highlighted

Returns: current PdfChoiceFormField

◆ SetMultiSelect()

virtual iText.Forms.Fields.PdfChoiceFormField iText.Forms.Fields.PdfChoiceFormField.SetMultiSelect ( bool multiSelect )

inlinevirtual

If true, more than one of the field's option items may be selected simultaneously; if false, at most one item shall be selected.

Parameters

multiSelect whether or not to allow multiple selection

Returns: current PdfChoiceFormField

◆ SetSort()

virtual iText.Forms.Fields.PdfChoiceFormField iText.Forms.Fields.PdfChoiceFormField.SetSort ( bool sort )

inlinevirtual

If true, the field's option items shall be sorted alphabetically.

If true, the field's option items shall be sorted alphabetically. This flag is intended for use by writers, not by readers.

Parameters

sort	whether or not to sort the items

Returns: current PdfChoiceFormField

◆ SetSpellCheck()

virtual iText.Forms.Fields.PdfChoiceFormField iText.Forms.Fields.PdfChoiceFormField.SetSpellCheck ( bool spellCheck )

inlinevirtual

If true, text entered in the field shall be spell-checked..

Parameters

spellCheck whether or not to require the PDF viewer to perform a spell check

Returns: current PdfChoiceFormField

◆ SetTopIndex()

virtual iText.Forms.Fields.PdfChoiceFormField iText.Forms.Fields.PdfChoiceFormField.SetTopIndex ( int index )

inlinevirtual

Sets the index of the first visible option in a scrollable list.

Parameters

index the index of the first option

Returns: current PdfChoiceFormField

Member Data Documentation

◆ FF_COMBO

readonly int iText.Forms.Fields.PdfChoiceFormField.FF_COMBO = MakeFieldFlag(18)

static

Choice field flags

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetFormType()

◆ GetIndices()

◆ GetTopIndex()

◆ IsCombo()

◆ IsCommitOnSelChange()

◆ IsEdit()

◆ IsMultiSelect()

◆ IsSort()

◆ IsSpellCheck()

◆ SetCombo()

◆ SetCommitOnSelChange()

◆ SetEdit()

◆ SetIndices()

◆ SetListSelected() [1/2]

◆ SetListSelected() [2/2]

◆ SetMultiSelect()

◆ SetSort()

◆ SetSpellCheck()

◆ SetTopIndex()

Member Data Documentation

◆ FF_COMBO