iText 8.0.5 API
iText.Forms.Fields.ChoiceFormFieldBuilder Class Reference

Builder for choice form field. More...

Inheritance diagram for iText.Forms.Fields.ChoiceFormFieldBuilder:
iText.Forms.Fields.TerminalFormFieldBuilder< iText.Forms.Fields.ChoiceFormFieldBuilder >

Public Member Functions

  ChoiceFormFieldBuilder (PdfDocument document, String formFieldName)
  Creates builder for PdfChoiceFormField creation. More...
 
virtual PdfArray  GetOptions ()
  Gets options for choice form field. More...
 
virtual iText.Forms.Fields.ChoiceFormFieldBuilder  SetOptions (PdfArray options)
  Sets options for choice form field. More...
 
virtual iText.Forms.Fields.ChoiceFormFieldBuilder  SetOptions (String[] options)
  Sets options for choice form field. More...
 
virtual iText.Forms.Fields.ChoiceFormFieldBuilder  SetOptions (String[][] options)
  Sets options for choice form field. More...
 
virtual PdfChoiceFormField  CreateList ()
  Creates list form field based on provided parameters. More...
 
virtual PdfChoiceFormField  CreateComboBox ()
  Creates combobox form field base on provided parameters. More...
 
- Public Member Functions inherited from iText.Forms.Fields.TerminalFormFieldBuilder< iText.Forms.Fields.ChoiceFormFieldBuilder >
virtual Rectangle  GetWidgetRectangle ()
  Gets rectangle which defines widget's placement. More...
 
virtual int  GetPage ()
  Gets page to be used for widget creation. More...
 
virtual T  SetPage (PdfPage page)
  Sets page to be used for widget creation. More...
 
virtual T  SetPage (int page)
  Sets page to be used for widget creation. More...
 
virtual T  SetWidgetRectangle (Rectangle widgetRectangle)
  Sets rectangle which defines widget's placement. More...
 
virtual T  SetFont (PdfFont font)
  Set font to be used for form field creation. More...
 
virtual PdfFont  GetFont ()
  Get font to be used for form field creation. More...
 

Package Functions

override iText.Forms.Fields.ChoiceFormFieldBuilder  GetThis ()
 
- Package Functions inherited from iText.Forms.Fields.TerminalFormFieldBuilder< iText.Forms.Fields.ChoiceFormFieldBuilder >
  TerminalFormFieldBuilder (PdfDocument document, String formFieldName)
  Creates builder for terminal form field creation. More...
 

Detailed Description

Builder for choice form field.

Constructor & Destructor Documentation

◆ ChoiceFormFieldBuilder()

iText.Forms.Fields.ChoiceFormFieldBuilder.ChoiceFormFieldBuilder ( PdfDocument  document,
String  formFieldName 
)
inline

Creates builder for PdfChoiceFormField creation.

Parameters
document document to be used for form field creation
formFieldName name of the form field

Member Function Documentation

◆ CreateComboBox()

virtual PdfChoiceFormField iText.Forms.Fields.ChoiceFormFieldBuilder.CreateComboBox ( )
inlinevirtual

Creates combobox form field base on provided parameters.

Returns
new PdfChoiceFormField instance

◆ CreateList()

virtual PdfChoiceFormField iText.Forms.Fields.ChoiceFormFieldBuilder.CreateList ( )
inlinevirtual

Creates list form field based on provided parameters.

Returns
new PdfChoiceFormField instance

◆ GetOptions()

virtual PdfArray iText.Forms.Fields.ChoiceFormFieldBuilder.GetOptions ( )
inlinevirtual

Gets options for choice form field.

Returns

iText.Kernel.Pdf.PdfArray of choice form field options

◆ GetThis()

override iText.Forms.Fields.ChoiceFormFieldBuilder iText.Forms.Fields.ChoiceFormFieldBuilder.GetThis ( )
inlinepackage

◆ SetOptions() [1/3]

virtual iText.Forms.Fields.ChoiceFormFieldBuilder iText.Forms.Fields.ChoiceFormFieldBuilder.SetOptions ( PdfArray  options )
inlinevirtual

Sets options for choice form field.

Parameters
options

iText.Kernel.Pdf.PdfArray of choice form field options

Returns
this builder

◆ SetOptions() [2/3]

virtual iText.Forms.Fields.ChoiceFormFieldBuilder iText.Forms.Fields.ChoiceFormFieldBuilder.SetOptions ( String[]  options )
inlinevirtual

Sets options for choice form field.

Parameters
options array of System.String options
Returns
this builder

◆ SetOptions() [3/3]

virtual iText.Forms.Fields.ChoiceFormFieldBuilder iText.Forms.Fields.ChoiceFormFieldBuilder.SetOptions ( String  options[][] )
inlinevirtual

Sets options for choice form field.

Parameters
options two-dimensional array of System.String options. Every inner array shall have two elements.
Returns
this builder