iText 7 7.1.9 API
iText.Forms.Fields.PdfFormField Class Reference

This class represents a single field or field group in an AcroForm. More...

Inheritance diagram for iText.Forms.Fields.PdfFormField:
iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary > iText.Forms.Fields.PdfButtonFormField iText.Forms.Fields.PdfChoiceFormField iText.Forms.Fields.PdfSignatureFormField iText.Forms.Fields.PdfTextFormField

Public Member Functions

  PdfFormField (PdfDictionary pdfObject)
  Creates a form field as a wrapper object around a iText.Kernel.Pdf.PdfDictionary. More...
 
virtual PdfName  GetFormType ()
  Returns the type of the parent form field, or of the wrapped <PdfDictionary> object. 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 Member Functions

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...
 

Static Public Attributes

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
 

Protected Member Functions

override bool  IsWrappedObjectMustBeIndirect ()
  Defines if the object behind this wrapper must be an indirect object in the resultant document. More...
 

Detailed Description

This class represents a single field or field group in an AcroForm.

This class represents a single field or field group in an AcroForm.

To be able to be wrapped with this iText.Kernel.Pdf.PdfObjectWrapper<T> the iText.Kernel.Pdf.PdfObject must be indirect.

Constructor & Destructor Documentation

◆ PdfFormField()

iText.Forms.Fields.PdfFormField.PdfFormField ( PdfDictionary  pdfObject )
inline

Creates a form field as a wrapper object around a iText.Kernel.Pdf.PdfDictionary.

Creates a form field as a wrapper object around a iText.Kernel.Pdf.PdfDictionary. This iText.Kernel.Pdf.PdfDictionary must be an indirect object.

Parameters
pdfObject the dictionary to be wrapped, must have an indirect reference.

Member Function Documentation

◆ AddKid() [1/2]

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.AddKid ( iText.Forms.Fields.PdfFormField  kid )
inlinevirtual

Adds a new kid to the Kids array property from a PdfFormField.

Adds a new kid to the Kids array property from a PdfFormField . Also sets the kid's Parent property to this object.

Parameters
kid a new PdfFormField entry for the field's Kids array property
Returns
the edited field

◆ AddKid() [2/2]

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.AddKid ( PdfWidgetAnnotation  kid )
inlinevirtual

Adds a new kid to the Kids array property from a iText.Kernel.Pdf.Annot.PdfWidgetAnnotation.

Adds a new kid to the Kids array property from a iText.Kernel.Pdf.Annot.PdfWidgetAnnotation . Also sets the kid's Parent property to this object.

Parameters
kid a new iText.Kernel.Pdf.Annot.PdfWidgetAnnotation entry for the field's Kids array property
Returns
the edited field

◆ CreateButton() [1/4]

static PdfButtonFormField iText.Forms.Fields.PdfFormField.CreateButton ( PdfDocument  doc,
int  flags 
)
inlinestatic

Creates an empty button form field with custom behavior and layout.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the button field in
flags an int, containing a set of binary behavioral flags. Do binary OR on this int to set the flags you require.
Returns
a new PdfButtonFormField

◆ CreateButton() [2/4]

static PdfButtonFormField iText.Forms.Fields.PdfFormField.CreateButton ( PdfDocument  doc,
int  flags,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates an empty button form field with custom behavior and layout.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the button field in
flags an int, containing a set of binary behavioral flags. Do binary OR on this int to set the flags you require.
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfButtonFormField

◆ CreateButton() [3/4]

static PdfButtonFormField iText.Forms.Fields.PdfFormField.CreateButton ( PdfDocument  doc,
Rectangle  rect,
int  flags 
)
inlinestatic

Creates an empty button form field with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the button field in
rect the location on the page for the button
flags an int, containing a set of binary behavioral flags. Do binary OR on this int to set the flags you require.
Returns
a new PdfButtonFormField

◆ CreateButton() [4/4]

static PdfButtonFormField iText.Forms.Fields.PdfFormField.CreateButton ( PdfDocument  doc,
Rectangle  rect,
int  flags,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates an empty button form field with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the button field in
rect the location on the page for the button
flags an int, containing a set of binary behavioral flags. Do binary OR on this int to set the flags you require.
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfButtonFormField

◆ CreateCheckBox() [1/3]

static PdfButtonFormField iText.Forms.Fields.PdfFormField.CreateCheckBox ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value 
)
inlinestatic

Creates a PdfButtonFormField as a checkbox.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the radio group in
rect the location on the page for the field
name the name of the form field
value the initial value
Returns
a new checkbox

◆ CreateCheckBox() [2/3]

static PdfButtonFormField iText.Forms.Fields.PdfFormField.CreateCheckBox ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
int  checkType 
)
inlinestatic

Creates a PdfButtonFormField as a checkbox.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the radio group in
rect the location on the page for the field
name the name of the form field
value the initial value
checkType the type of checkbox graphic to use.
Returns
a new checkbox

◆ CreateCheckBox() [3/3]

static PdfButtonFormField iText.Forms.Fields.PdfFormField.CreateCheckBox ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
int  checkType,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates a PdfButtonFormField as a checkbox.

Creates a PdfButtonFormField as a checkbox. Check symbol will fit rectangle. You may set font and font size after creation.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the radio group in
rect the location on the page for the field
name the name of the form field
value the initial value
checkType the type of checkbox graphic to use.
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new checkbox

◆ CreateChoice() [1/7]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateChoice ( PdfDocument  doc,
int  flags 
)
inlinestatic

Creates an empty choice form field.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the choice field in
flags an int, containing a set of binary behavioral flags. Do binary OR on this int to set the flags you require.
Returns
a new PdfChoiceFormField

◆ CreateChoice() [2/7]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateChoice ( PdfDocument  doc,
int  flags,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates an empty choice form field.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the choice field in
flags an int, containing a set of binary behavioral flags. Do binary OR on this int to set the flags you require.
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfChoiceFormField

◆ CreateChoice() [3/7]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateChoice ( PdfDocument  doc,
Rectangle  rect,
int  flags 
)
inlinestatic

Creates an empty choice form field with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the choice field in
rect the location on the page for the choice field
flags an int, containing a set of binary behavioral flags. Do binary OR on this int to set the flags you require.
Returns
a new PdfChoiceFormField

◆ CreateChoice() [4/7]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateChoice ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
PdfArray  options,
int  flags 
)
inlinestatic

Creates a choice form field with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the choice field in
rect the location on the page for the choice field
name the name of the form field
value the initial value
options an array of iText.Kernel.Pdf.PdfString objects that each represent the 'on' state of one of the choices.
flags an int, containing a set of binary behavioral flags. Do binary OR on this int to set the flags you require.
Returns
a new PdfChoiceFormField

◆ CreateChoice() [5/7]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateChoice ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
PdfArray  options,
int  flags,
PdfFont  font,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates a choice form field with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the choice field in
rect the location on the page for the choice field
name the name of the form field
value the initial value
options an array of iText.Kernel.Pdf.PdfString objects that each represent the 'on' state of one of the choices.
flags an int, containing a set of binary behavioral flags. Do binary OR on this int to set the flags you require.
font the desired font to be used when displaying the text
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfChoiceFormField

◆ CreateChoice() [6/7]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateChoice ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
PdfFont  font,
float  fontSize,
PdfArray  options,
int  flags 
)
inlinestatic

Creates a choice form field with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the choice field in
rect the location on the page for the choice field
name the name of the form field
value the initial value
font a iText.Kernel.Font.PdfFont
fontSize the size of the font
options an array of iText.Kernel.Pdf.PdfString objects that each represent the 'on' state of one of the choices.
flags an int, containing a set of binary behavioral flags. Do binary OR on this int to set the flags you require.
Returns
a new PdfChoiceFormField

◆ CreateChoice() [7/7]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateChoice ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
PdfFont  font,
float  fontSize,
PdfArray  options,
int  flags,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates a choice form field with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the choice field in
rect the location on the page for the choice field
name the name of the form field
value the initial value
font a iText.Kernel.Font.PdfFont
fontSize the size of the font
options an array of iText.Kernel.Pdf.PdfString objects that each represent the 'on' state of one of the choices.
flags an int, containing a set of binary behavioral flags. Do binary OR on this int to set the flags you require.
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfChoiceFormField

◆ CreateComboBox() [1/4]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateComboBox ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
String[]  options 
)
inlinestatic

Creates a combobox with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the combobox in
rect the location on the page for the combobox
name the name of the form field
value the initial value
options an array of Strings which will be converted to a PdfArray.
Returns
a new PdfChoiceFormField as a combobox

◆ CreateComboBox() [2/4]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateComboBox ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
String[]  options,
PdfFont  font,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates a combobox with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the combobox in
rect the location on the page for the combobox
name the name of the form field
value the initial value
options an array of Strings which will be converted to a PdfArray.
font the desired font to be used when displaying the text
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfChoiceFormField as a combobox

◆ CreateComboBox() [3/4]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateComboBox ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
String  options[][] 
)
inlinestatic

Creates a combobox with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the combobox in
rect the location on the page for the combobox
name the name of the form field
value the initial value
options a two-dimensional array of Strings which will be converted to a PdfArray.
Returns
a new PdfChoiceFormField as a combobox

◆ CreateComboBox() [4/4]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateComboBox ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
String  options[][],
PdfFont  font,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates a combobox with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the combobox in
rect the location on the page for the combobox
name the name of the form field
value the initial value
options a two-dimensional array of Strings which will be converted to a PdfArray.
font the desired font to be used when displaying the text
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfChoiceFormField as a combobox

◆ CreateEmptyField() [1/2]

static iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.CreateEmptyField ( PdfDocument  doc )
inlinestatic

Creates an empty form field without a predefined set of layout or behavior.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the field in
Returns
a new PdfFormField

◆ CreateEmptyField() [2/2]

static iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.CreateEmptyField ( PdfDocument  doc,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates an empty form field without a predefined set of layout or behavior.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the field in
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfFormField

◆ CreateList() [1/4]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateList ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
String[]  options 
)
inlinestatic

Creates a list field with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the list field in
rect the location on the page for the list field
name the name of the form field
value the initial value
options an array of Strings which will be converted to a PdfArray.
Returns
a new PdfChoiceFormField as a list field

◆ CreateList() [2/4]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateList ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
String[]  options,
PdfFont  font,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates a list field with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the list field in
rect the location on the page for the list field
name the name of the form field
value the initial value
options an array of Strings which will be converted to a PdfArray.
font the desired font to be used when displaying the text
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfChoiceFormField as a list field

◆ CreateList() [3/4]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateList ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
String  options[][] 
)
inlinestatic

Creates a list field with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the choice field in
rect the location on the page for the choice field
name the name of the form field
value the initial value
options a two-dimensional array of Strings which will be converted to a PdfArray.
Returns
a new PdfChoiceFormField as a list field

◆ CreateList() [4/4]

static PdfChoiceFormField iText.Forms.Fields.PdfFormField.CreateList ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
String  options[][],
PdfFont  font,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates a list field with custom behavior and layout, on a specified location.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the choice field in
rect the location on the page for the choice field
name the name of the form field
value the initial value
options a two-dimensional array of Strings which will be converted to a PdfArray.
font the desired font to be used when displaying the text
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfChoiceFormField as a list field

◆ CreateMultilineText() [1/2]

static PdfTextFormField iText.Forms.Fields.PdfFormField.CreateMultilineText ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value 
)
inlinestatic

Creates a named multiline text form field with an initial value, and the form's default font specified in iText.Forms.PdfAcroForm.GetDefaultResources().

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the text field in
rect the location on the page for the text field
name the name of the form field
value the initial value
Returns
a new PdfTextFormField

◆ CreateMultilineText() [2/2]

static PdfTextFormField iText.Forms.Fields.PdfFormField.CreateMultilineText ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
PdfFont  font,
float  fontSize 
)
inlinestatic

Creates a named multilined text form field with an initial value, with a specified font and font size.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the text field in
rect the location on the page for the text field
name the name of the form field
value the initial value
font a iText.Kernel.Font.PdfFont
fontSize the size of the font
Returns
a new PdfTextFormField

◆ CreatePushButton() [1/3]

static PdfButtonFormField iText.Forms.Fields.PdfFormField.CreatePushButton ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  caption 
)
inlinestatic

Creates a PdfButtonFormField as a push button without data.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the radio group in
rect the location on the page for the field
name the name of the form field
caption the text to display on the button
Returns
a new PdfButtonFormField

◆ CreatePushButton() [2/3]

static PdfButtonFormField iText.Forms.Fields.PdfFormField.CreatePushButton ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  caption,
PdfFont  font,
float  fontSize 
)
inlinestatic

Creates a PdfButtonFormField as a push button without data, with its caption in a custom font.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the radio group in
rect the location on the page for the field
name the name of the form field
caption the text to display on the button
font a iText.Kernel.Font.PdfFont
fontSize the size of the font
Returns
a new PdfButtonFormField

◆ CreatePushButton() [3/3]

static PdfButtonFormField iText.Forms.Fields.PdfFormField.CreatePushButton ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  caption,
PdfFont  font,
float  fontSize,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates a PdfButtonFormField as a push button without data, with its caption in a custom font.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the radio group in
rect the location on the page for the field
name the name of the form field
caption the text to display on the button
font a iText.Kernel.Font.PdfFont
fontSize the size of the font
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfButtonFormField

◆ CreateRadioButton() [1/2]

static iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.CreateRadioButton ( PdfDocument  doc,
Rectangle  rect,
PdfButtonFormField  radioGroup,
String  value 
)
inlinestatic

Creates a generic PdfFormField that is added to a radio group.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the radio group in
rect the location on the page for the field
radioGroup the radio button group that this field should belong to
value the initial value
Returns
a new PdfFormField
See also
CreateRadioGroup(iText.Kernel.Pdf.PdfDocument, System.String, System.String)

◆ CreateRadioButton() [2/2]

static iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.CreateRadioButton ( PdfDocument  doc,
Rectangle  rect,
PdfButtonFormField  radioGroup,
String  value,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates a generic PdfFormField that is added to a radio group.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the radio group in
rect the location on the page for the field
radioGroup the radio button group that this field should belong to
value the initial value
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfFormField
See also
CreateRadioGroup(iText.Kernel.Pdf.PdfDocument, System.String, System.String)

◆ CreateRadioGroup() [1/2]

static PdfButtonFormField iText.Forms.Fields.PdfFormField.CreateRadioGroup ( PdfDocument  doc,
String  name,
String  value 
)
inlinestatic

Creates a radio group form field.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the radio group in
name the name of the form field
value the initial value
Returns
a new radio group

◆ CreateRadioGroup() [2/2]

static PdfButtonFormField iText.Forms.Fields.PdfFormField.CreateRadioGroup ( PdfDocument  doc,
String  name,
String  value,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates a radio group form field.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the radio group in
name the name of the form field
value the initial value
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new radio group

◆ CreateSignature() [1/4]

static PdfSignatureFormField iText.Forms.Fields.PdfFormField.CreateSignature ( PdfDocument  doc )
inlinestatic

Creates an empty signature form field.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the signature field in
Returns
a new PdfSignatureFormField

◆ CreateSignature() [2/4]

static PdfSignatureFormField iText.Forms.Fields.PdfFormField.CreateSignature ( PdfDocument  doc,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates an empty signature form field.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the signature field in
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfSignatureFormField

◆ CreateSignature() [3/4]

static PdfSignatureFormField iText.Forms.Fields.PdfFormField.CreateSignature ( PdfDocument  doc,
Rectangle  rect 
)
inlinestatic

Creates an empty signature form field.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the signature field in
rect the location on the page for the signature field
Returns
a new PdfSignatureFormField

◆ CreateSignature() [4/4]

static PdfSignatureFormField iText.Forms.Fields.PdfFormField.CreateSignature ( PdfDocument  doc,
Rectangle  rect,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates an empty signature form field.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the signature field in
rect the location on the page for the signature field
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfSignatureFormField

◆ CreateText() [1/8]

static PdfTextFormField iText.Forms.Fields.PdfFormField.CreateText ( PdfDocument  doc )
inlinestatic

Creates an empty text form field.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the text field in
Returns
a new PdfTextFormField

◆ CreateText() [2/8]

static PdfTextFormField iText.Forms.Fields.PdfFormField.CreateText ( PdfDocument  doc,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates an empty text form field.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the text field in
pdfAConformanceLevel the desired iText.Kernel.Pdf.PdfAConformanceLevel of the field. Must match the conformance level of the iText.Kernel.Pdf.PdfDocument this field will eventually be added into
Returns
a new PdfTextFormField

◆ CreateText() [3/8]

static PdfTextFormField iText.Forms.Fields.PdfFormField.CreateText ( PdfDocument  doc,
Rectangle  rect 
)
inlinestatic

Creates an empty text form field.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the text field in
rect the location on the page for the text field
Returns
a new PdfTextFormField

◆ CreateText() [4/8]

static PdfTextFormField iText.Forms.Fields.PdfFormField.CreateText ( PdfDocument  doc,
Rectangle  rect,
String  name 
)
inlinestatic

Creates a named text form field with an initial value, and the form's default font specified in iText.Forms.PdfAcroForm.GetDefaultResources().

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the text field in
rect the location on the page for the text field
name the name of the form field
Returns
a new PdfTextFormField

◆ CreateText() [5/8]

static PdfTextFormField iText.Forms.Fields.PdfFormField.CreateText ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value 
)
inlinestatic

Creates a named text form field with an initial value, and the form's default font specified in iText.Forms.PdfAcroForm.GetDefaultResources().

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the text field in
rect the location on the page for the text field
name the name of the form field
value the initial value
Returns
a new PdfTextFormField

◆ CreateText() [6/8]

static PdfTextFormField iText.Forms.Fields.PdfFormField.CreateText ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
PdfFont  font,
float  fontSize 
)
inlinestatic

Creates a named text form field with an initial value, with a specified font and font size.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the text field in
rect the location on the page for the text field
name the name of the form field
value the initial value
font a iText.Kernel.Font.PdfFont
fontSize the size of the font
Returns
a new PdfTextFormField

◆ CreateText() [7/8]

static PdfTextFormField iText.Forms.Fields.PdfFormField.CreateText ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
PdfFont  font,
float  fontSize,
bool  multiline 
)
inlinestatic

Creates a named text form field with an initial value, with a specified font and font size.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the text field in
rect the location on the page for the text field
name the name of the form field
value the initial value
font a iText.Kernel.Font.PdfFont
fontSize the size of the font
multiline true for multiline text field
Returns
a new PdfTextFormField

◆ CreateText() [8/8]

static PdfTextFormField iText.Forms.Fields.PdfFormField.CreateText ( PdfDocument  doc,
Rectangle  rect,
String  name,
String  value,
PdfFont  font,
float  fontSize,
bool  multiline,
PdfAConformanceLevel  pdfAConformanceLevel 
)
inlinestatic

Creates a named text form field with an initial value, with a specified font and font size.

Parameters
doc the iText.Kernel.Pdf.PdfDocument to create the text field in
rect the location on the page for the text field
name the name of the form field
value the initial value
font a iText.Kernel.Font.PdfFont
fontSize the size of the font
multiline true for multiline text field
pdfAConformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel of the document. null if it's no PDF/A document
Returns
a new PdfTextFormField

◆ GetAdditionalAction()

virtual PdfDictionary iText.Forms.Fields.PdfFormField.GetAdditionalAction ( )
inlinevirtual

Gets the currently additional action dictionary for the form field.

Returns
the additional action dictionary

◆ GetAlternativeName()

virtual PdfString iText.Forms.Fields.PdfFormField.GetAlternativeName ( )
inlinevirtual

Gets the current alternate name.

Gets the current alternate name. The alternate is a descriptive name to be used by status messages etc.

Returns
the current alternate name, as a iText.Kernel.Pdf.PdfString

◆ GetAppearanceStates()

virtual String [] iText.Forms.Fields.PdfFormField.GetAppearanceStates ( )
inlinevirtual

Gets the appearance state names.

Returns
an array of Strings containing the names of the appearance states

◆ GetBorderWidth()

virtual float iText.Forms.Fields.PdfFormField.GetBorderWidth ( )
inlinevirtual

Gets the border width for the field.

Returns
the current border width.

◆ GetColor()

virtual Color iText.Forms.Fields.PdfFormField.GetColor ( )
inlinevirtual

Gets the current color of the form field.

Returns
the current color

◆ GetDefaultAppearance()

virtual PdfString iText.Forms.Fields.PdfFormField.GetDefaultAppearance ( )
inlinevirtual

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.

Returns
the default appearance graphics, as a iText.Kernel.Pdf.PdfString

◆ GetDefaultStyle()

virtual PdfString iText.Forms.Fields.PdfFormField.GetDefaultStyle ( )
inlinevirtual

Gets a default style string, as described in "Rich Text Strings" section of Pdf spec.

Returns
the default style, as a iText.Kernel.Pdf.PdfString

◆ GetDefaultValue()

virtual PdfObject iText.Forms.Fields.PdfFormField.GetDefaultValue ( )
inlinevirtual

Gets the default fallback value for the form field.

Returns
the default value

◆ GetFieldFlag()

virtual bool iText.Forms.Fields.PdfFormField.GetFieldFlag ( int  flag )
inlinevirtual

Checks whether a certain flag, or any of a combination of flags, is set for this form field.

Parameters
flag an int interpreted as a series of a binary flags
Returns
true if any of the flags specified in the parameter is also set in the form field.

◆ GetFieldFlags()

virtual int iText.Forms.Fields.PdfFormField.GetFieldFlags ( )
inlinevirtual

Gets the current list of PDF form field flags.

Returns
the current list of flags, encoded as an int

◆ GetFieldName()

virtual PdfString iText.Forms.Fields.PdfFormField.GetFieldName ( )
inlinevirtual

Gets the current field name.

Returns
the current field name, as a iText.Kernel.Pdf.PdfString

◆ GetFont()

virtual PdfFont iText.Forms.Fields.PdfFormField.GetFont ( )
inlinevirtual

Gets the current font of the form field.

Returns
the current font

◆ GetFontSize()

virtual float iText.Forms.Fields.PdfFormField.GetFontSize ( )
inlinevirtual

Gets the current fontSize of the form field.

Returns
the current fontSize

◆ GetFormType()

virtual PdfName iText.Forms.Fields.PdfFormField.GetFormType ( )
inlinevirtual

Returns the type of the parent form field, or of the wrapped <PdfDictionary> object.

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

Reimplemented in iText.Forms.Fields.PdfChoiceFormField, iText.Forms.Fields.PdfButtonFormField, iText.Forms.Fields.PdfTextFormField, and iText.Forms.Fields.PdfSignatureFormField.

◆ GetJustification()

virtual ? int iText.Forms.Fields.PdfFormField.GetJustification ( )
inlinevirtual

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

Returns
the current justification attribute

◆ GetKids()

virtual PdfArray iText.Forms.Fields.PdfFormField.GetKids ( )
inlinevirtual

Gets the kids of this object.

Returns
contents of the dictionary's Kids property, as a iText.Kernel.Pdf.PdfArray

◆ GetMappingName()

virtual PdfString iText.Forms.Fields.PdfFormField.GetMappingName ( )
inlinevirtual

Gets the current mapping name.

Gets the current mapping name. The mapping name can be used when exporting the form data in the document.

Returns
the current mapping name, as a iText.Kernel.Pdf.PdfString

◆ GetOptions()

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

Gets options for the form field.

Gets options for the form field. Should only return usable values for checkboxes and radio buttons.

Returns
the options, as an iText.Kernel.Pdf.PdfArray of iText.Kernel.Pdf.PdfString objects

◆ GetParent()

virtual PdfDictionary iText.Forms.Fields.PdfFormField.GetParent ( )
inlinevirtual

Gets the parent dictionary.

Returns
another form field that this field belongs to, usually a group field

◆ GetRichText()

virtual PdfObject iText.Forms.Fields.PdfFormField.GetRichText ( )
inlinevirtual

Gets a rich text string, as described in "Rich Text Strings" section of Pdf spec.

Gets a rich text string, as described in "Rich Text Strings" section of Pdf spec. May be either iText.Kernel.Pdf.PdfStream or iText.Kernel.Pdf.PdfString.

Returns
the current rich text value

◆ GetValue()

virtual PdfObject iText.Forms.Fields.PdfFormField.GetValue ( )
inlinevirtual

Gets the current value contained in the form field.

Returns
the current value, as a iText.Kernel.Pdf.PdfObject

◆ GetValueAsString()

virtual String iText.Forms.Fields.PdfFormField.GetValueAsString ( )
inlinevirtual

Gets the current value contained in the form field.

Returns
the current value, as a System.String

◆ GetWidgets()

virtual IList<PdfWidgetAnnotation> iText.Forms.Fields.PdfFormField.GetWidgets ( )
inlinevirtual

Gets all iText.Kernel.Pdf.Annot.PdfWidgetAnnotation that this form field and its kids refer to.

Returns
a list of iText.Kernel.Pdf.Annot.PdfWidgetAnnotation

◆ IsMultiline()

virtual bool iText.Forms.Fields.PdfFormField.IsMultiline ( )
inlinevirtual

If true, the field can contain multiple lines of text; if false, the field's text is restricted to a single line.

Returns
whether the field can span over multiple lines.

◆ IsNoExport()

virtual bool iText.Forms.Fields.PdfFormField.IsNoExport ( )
inlinevirtual

Gets the NoExport attribute.

Returns
whether exporting the value following a form action is forbidden.

◆ IsPassword()

virtual bool iText.Forms.Fields.PdfFormField.IsPassword ( )
inlinevirtual

If true, the field is intended for entering a secure password that should not be echoed visibly to the screen.

If true, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters.

Returns
whether or not the contents of the field must be obfuscated

◆ IsReadOnly()

virtual bool iText.Forms.Fields.PdfFormField.IsReadOnly ( )
inlinevirtual

Gets the ReadOnly flag, specifying whether or not the field can be changed.

Returns
true if the field cannot be changed.

◆ IsRequired()

virtual bool iText.Forms.Fields.PdfFormField.IsRequired ( )
inlinevirtual

Gets the Required flag, specifying whether or not the field must be filled in.

Returns
true if the field must be filled in.

◆ IsWrappedObjectMustBeIndirect()

override bool iText.Forms.Fields.PdfFormField.IsWrappedObjectMustBeIndirect ( )
inlineprotectedvirtual

Defines if the object behind this wrapper must be an indirect object in the resultant document.

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Returns
true if in the resultant document the object behind the wrapper must be indirect, otherwise false.

Implements iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >.

◆ MakeFieldFlag()

static int iText.Forms.Fields.PdfFormField.MakeFieldFlag ( int  bitPosition )
inlinestatic

Makes a field flag by bit position.

Makes a field flag by bit position. Bit positions are numbered 1 to 32. But position 0 corresponds to flag 1, position 3 corresponds to flag 4 etc.

Parameters
bitPosition bit position of a flag in range 1 to 32 from the pdf specification.
Returns
corresponding field flag.

◆ MakeFormField()

static iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.MakeFormField ( PdfObject  pdfObject,
PdfDocument  document 
)
inlinestatic

Creates a (subtype of) PdfFormField object.

Creates a (subtype of) PdfFormField object. The type of the object depends on the FT entry in the pdfObject parameter.

Parameters
pdfObject assumed to be either a iText.Kernel.Pdf.PdfDictionary , or a iText.Kernel.Pdf.PdfIndirectReference to a iText.Kernel.Pdf.PdfDictionary
document the iText.Kernel.Pdf.PdfDocument to create the field in
Returns
a new PdfFormField , or null if pdfObject does not contain a FT entry

◆ RegenerateField()

virtual bool iText.Forms.Fields.PdfFormField.RegenerateField ( )
inlinevirtual

This method regenerates appearance stream of the field.

This method regenerates appearance stream of the field. Use it if you changed any field parameters and didn't use setValue method which generates appearance by itself.

Returns
whether or not the regeneration was successful.

◆ Release()

virtual void iText.Forms.Fields.PdfFormField.Release ( )
inlinevirtual

Releases underlying pdf object and other pdf entities used by wrapper.

Releases underlying pdf object and other pdf entities used by wrapper. This method should be called instead of direct call to iText.Kernel.Pdf.PdfObject.Release() if the wrapper is used.

◆ SetAction()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetAction ( PdfAction  action )
inlinevirtual

Sets the action on all widgets of this form field.

Parameters
action The action
Returns
The edited field

◆ SetAdditionalAction()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetAdditionalAction ( PdfName  key,
PdfAction  action 
)
inlinevirtual

Sets an additional action for the form field.

Parameters
key the dictionary key to use for storing the action
action the action
Returns
the edited field

◆ SetAlternativeName()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetAlternativeName ( String  name )
inlinevirtual

Changes the alternate name of the field to the specified value.

Changes the alternate name of the field to the specified value. The alternate is a descriptive name to be used by status messages etc.

Parameters
name the new alternate name, as a String
Returns
the edited field

◆ SetAppearance()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetAppearance ( PdfName  appearanceType,
String  appearanceState,
PdfStream  appearanceStream 
)
inlinevirtual

Sets an appearance for (the widgets related to) the form field.

Parameters
appearanceType the type of appearance stream to be added
  • PdfName.N: normal appearance
  • PdfName.R: rollover appearance
  • PdfName.D: down appearance
appearanceState the state of the form field that needs to be true for the appearance to be used. Differentiates between several streams of the same type.
appearanceStream the appearance instructions, as a iText.Kernel.Pdf.PdfStream
Returns
the edited field

◆ SetBackgroundColor()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetBackgroundColor ( Color  backgroundColor )
inlinevirtual

Basic setter for the backgroundColor property.

Basic setter for the backgroundColor property. Regenerates the field appearance after setting the new value.

Parameters
backgroundColor The new color to be set or null if no background needed
Returns
The edited PdfFormField

◆ SetBorderColor()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetBorderColor ( Color  color )
inlinevirtual

Sets the Border Color.

Parameters
color the new value for the Border Color
Returns
the edited field

◆ SetBorderWidth()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetBorderWidth ( float  borderWidth )
inlinevirtual

Sets the border width for the field.

Parameters
borderWidth The new border width.
Returns
The edited field

◆ SetCheckType()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetCheckType ( int  checkType )
inlinevirtual

Changes the type of graphical marker used to mark a checkbox as 'on'.

Changes the type of graphical marker used to mark a checkbox as 'on'. Notice that in order to complete the change one should call regenerateField method

Parameters
checkType the new checkbox marker
Returns
The edited field

◆ SetColor()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetColor ( Color  color )
inlinevirtual

Sets the text color.

Parameters
color the new value for the Color
Returns
the edited field

◆ SetDefaultAppearance()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetDefaultAppearance ( String  defaultAppearance )
inlinevirtual

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.

Parameters
defaultAppearance a valid sequence of PDF content stream syntax
Returns
the edited field

◆ SetDefaultStyle()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetDefaultStyle ( PdfString  defaultStyleString )
inlinevirtual

Sets a default style string, as described in "Rich Text Strings" section of Pdf spec.

Parameters
defaultStyleString a new default style for the form field
Returns
the edited field

◆ SetDefaultValue()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetDefaultValue ( PdfObject  value )
inlinevirtual

Sets the default fallback value for the form field.

Parameters
value the default value
Returns
the edited field

◆ SetFieldFlag() [1/2]

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetFieldFlag ( int  flag )
inlinevirtual

Adds a flag, or combination of flags, for the form field.

Adds a flag, or combination of flags, for the form field. This method is intended to be used one flag at a time, but this is not technically enforced. To replace the current value, use SetFieldFlags(int).

Parameters
flag an int interpreted as a series of a binary flags
Returns
the edited field

◆ SetFieldFlag() [2/2]

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetFieldFlag ( int  flag,
bool  value 
)
inlinevirtual

Adds or removes a flag, or combination of flags, for the form field.

Adds or removes a flag, or combination of flags, for the form field. This method is intended to be used one flag at a time, but this is not technically enforced. To replace the current value, use SetFieldFlags(int).

Parameters
flag an int interpreted as a series of a binary flags
value if true, adds the flag(s). if false, removes the flag(s).
Returns
the edited field

◆ SetFieldFlags()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetFieldFlags ( int  flags )
inlinevirtual

Sets a flag, or combination of flags, for the form field.

Sets a flag, or combination of flags, for the form field. This method replaces the previous value. Compare with SetFieldFlag(int) which adds a flag to the existing flags.

Parameters
flags an int interpreted as a series of a binary flags
Returns
the edited field

◆ SetFieldName()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetFieldName ( String  name )
inlinevirtual

Changes the name of the field to the specified value.

Parameters
name the new field name, as a String
Returns
the edited field

◆ SetFont()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetFont ( PdfFont  font )
inlinevirtual

Basic setter for the font property.

Basic setter for the font property. Regenerates the field appearance after setting the new value. Note that the font will be added to the document so ensure that the font is embedded if it's a pdf/a document.

Parameters
font The new font to be set
Returns
The edited PdfFormField

◆ SetFontAndSize() [1/2]

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetFontAndSize ( PdfFont  font,
float  fontSize 
)
inlinevirtual

Combined setter for the font and fontSize properties.

Combined setter for the font and fontSize properties. Regenerates the field appearance after setting the new value.

Parameters
font The new font to be set
fontSize The new font size to be set
Returns
The edited PdfFormField

◆ SetFontAndSize() [2/2]

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetFontAndSize ( PdfFont  font,
int  fontSize 
)
inlinevirtual

Combined setter for the font and fontSize properties.

Combined setter for the font and fontSize properties. Regenerates the field appearance after setting the new value.

Parameters
font The new font to be set
fontSize The new font size to be set
Returns
The edited PdfFormField

◆ SetFontSize() [1/2]

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetFontSize ( float  fontSize )
inlinevirtual

Basic setter for the fontSize property.

Basic setter for the fontSize property. Regenerates the field appearance after setting the new value.

Parameters
fontSize The new font size to be set
Returns
The edited PdfFormField

◆ SetFontSize() [2/2]

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetFontSize ( int  fontSize )
inlinevirtual

Basic setter for the fontSize property.

Basic setter for the fontSize property. Regenerates the field appearance after setting the new value.

Parameters
fontSize The new font size to be set
Returns
The edited PdfFormField

◆ SetFontSizeAutoScale()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetFontSizeAutoScale ( )
inlinevirtual

Sets zero font size which will be interpreted as auto-size according to ISO 32000-1, 12.7.3.3.

Returns
the edited field

◆ SetJustification()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetJustification ( int  justification )
inlinevirtual

Sets a code specifying the form of quadding (justification) to be used in displaying the text: 0 Left-justified 1 Centered 2 Right-justified

Parameters
justification the value to set the justification attribute to
Returns
the edited field

◆ SetMappingName()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetMappingName ( String  name )
inlinevirtual

Changes the mapping name of the field to the specified value.

Changes the mapping name of the field to the specified value. The mapping name can be used when exporting the form data in the document.

Parameters
name the new alternate name, as a String
Returns
the edited field

◆ SetNoExport()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetNoExport ( bool  noExport )
inlinevirtual

Sets the NoExport flag, specifying whether or not exporting is forbidden.

Parameters
noExport if true, then exporting is forbidden
Returns
the edited field

◆ SetOptions()

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

Sets options for the form field.

Sets options for the form field. Only to be used for checkboxes and radio buttons.

Parameters
options an array of iText.Kernel.Pdf.PdfString objects that each represent the 'on' state of one of the choices.
Returns
the edited field

◆ SetPage()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetPage ( int  pageNum )
inlinevirtual

Specifies on which page the form field's widget must be shown.

Parameters
pageNum the page number
Returns
the edited field

◆ SetParent()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetParent ( iText.Forms.Fields.PdfFormField  parent )
inlinevirtual

Sets a parent PdfFormField for the current object.

Parameters
parent another form field that this field belongs to, usually a group field
Returns
the edited field

◆ SetReadOnly()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetReadOnly ( bool  readOnly )
inlinevirtual

Sets the ReadOnly flag, specifying whether or not the field can be changed.

Parameters
readOnly if true, then the field cannot be changed.
Returns
the edited field

◆ SetRequired()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetRequired ( bool  required )
inlinevirtual

Sets the Required flag, specifying whether or not the field must be filled in.

Parameters
required if true, then the field must be filled in.
Returns
the edited field

◆ SetRichText()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetRichText ( PdfObject  richText )
inlinevirtual

Sets a rich text string, as described in "Rich Text Strings" section of Pdf spec.

Sets a rich text string, as described in "Rich Text Strings" section of Pdf spec. May be either iText.Kernel.Pdf.PdfStream or iText.Kernel.Pdf.PdfString.

Parameters
richText a new rich text value
Returns
The edited PdfFormField

◆ SetRotation()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetRotation ( int  degRotation )
inlinevirtual

Basic setter for the degRotation property.

Basic setter for the degRotation property. Regenerates the field appearance after setting the new value.

Parameters
degRotation The new degRotation to be set
Returns
The edited PdfFormField

◆ SetValue() [1/4]

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetValue ( String  value )
inlinevirtual

Sets a value to the field and generating field appearance if needed.

Parameters
value of the field
Returns
the field

◆ SetValue() [2/4]

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetValue ( String  value,
bool  generateAppearance 
)
inlinevirtual

Sets a value to the field and generating field appearance if needed.

Parameters
value of the field
generateAppearance set this flat to false if you want to keep the appearance of the field generated before
Returns
the field

◆ SetValue() [3/4]

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetValue ( String  value,
PdfFont  font,
float  fontSize 
)
inlinevirtual

Set text field value with given font and size

Parameters
value text value
font a iText.Kernel.Font.PdfFont
fontSize the size of the font
Returns
the edited field

◆ SetValue() [4/4]

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetValue ( String  value,
String  display 
)
inlinevirtual

Sets the field value and the display string.

Sets the field value and the display string. The display string is used to build the appearance.

Parameters
value the field value
display the string that is used for the appearance. If null the value parameter will be used
Returns
the edited field

◆ SetVisibility()

virtual iText.Forms.Fields.PdfFormField iText.Forms.Fields.PdfFormField.SetVisibility ( int  visibility )
inlinevirtual

Set the visibility flags of the form field annotation Options are: HIDDEN, HIDDEN_BUT_PRINTABLE, VISIBLE, VISIBLE_BUT_DOES_NOT_PRINT

Parameters
visibility visibility option
Returns
The edited field

◆ UpdateDefaultAppearance()

virtual void iText.Forms.Fields.PdfFormField.UpdateDefaultAppearance ( )
inlinevirtual

Updates DA for Variable text, Push button and choice form fields.

Updates DA for Variable text, Push button and choice form fields. The resources required for DA will be put to AcroForm's DR. Note, for other form field types DA will be removed.

Member Data Documentation

◆ DEFAULT_FONT_SIZE

const int iText.Forms.Fields.PdfFormField.DEFAULT_FONT_SIZE = 12
static

Size of text in form fields when font size is not explicitly set.

◆ FF_MULTILINE

readonly int iText.Forms.Fields.PdfFormField.FF_MULTILINE = MakeFieldFlag(13)
static

Flag that designates, if set, that the field can contain multiple lines of text.

◆ FF_PASSWORD

readonly int iText.Forms.Fields.PdfFormField.FF_PASSWORD = MakeFieldFlag(14)
static

Flag that designates, if set, that the field's contents must be obfuscated.

◆ TYPE_CHECK

const int iText.Forms.Fields.PdfFormField.TYPE_CHECK = 1
static

A field with the symbol check

◆ TYPE_CIRCLE

const int iText.Forms.Fields.PdfFormField.TYPE_CIRCLE = 2
static

A field with the symbol circle

◆ TYPE_CROSS

const int iText.Forms.Fields.PdfFormField.TYPE_CROSS = 3
static

A field with the symbol cross

◆ TYPE_DIAMOND

const int iText.Forms.Fields.PdfFormField.TYPE_DIAMOND = 4
static

A field with the symbol diamond

◆ TYPE_SQUARE

const int iText.Forms.Fields.PdfFormField.TYPE_SQUARE = 5
static

A field with the symbol square

◆ TYPE_STAR

const int iText.Forms.Fields.PdfFormField.TYPE_STAR = 6
static

A field with the symbol star