Skip to main content
Skip table of contents

PdfAcroForm

PdfAcroForm Public class

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph iTextSharp.text.pdf
  iTextSharp.text.pdf.PdfAcroForm[[PdfAcroForm]]
  iTextSharp.text.pdf.PdfDictionary[[PdfDictionary]]
  end
iTextSharp.text.pdf.PdfDictionary --> iTextSharp.text.pdf.PdfAcroForm

Members

Properties

Public properties
TypeNameMethods
boolNeedAppearancesset
intSigFlagsset

Methods

Public methods
ReturnsName
voidAddCalculationOrder(PdfFormField formField)
PdfFormFieldAddCheckBox(string name, string value, bool status, float llx, float lly, float urx, float ury)
PdfFormFieldAddComboBox(...)
voidAddDocumentField(PdfIndirectReference piref)
voidAddFieldTemplates(Dictionary<PdfTemplate, object> ft)
voidAddFormField(PdfFormField formField)
PdfFormFieldAddHiddenField(string name, string value)
PdfFormFieldAddHtmlPostButton(string name, string caption, string value, string url, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
PdfFormFieldAddMap(string name, string value, string url, PdfContentByte appearance, float llx, float lly, float urx, float ury)
PdfFormFieldAddMultiLineTextField(string name, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
PdfFormFieldAddRadioButton(PdfFormField radiogroup, string value, float llx, float lly, float urx, float ury)
voidAddRadioGroup(PdfFormField radiogroup)
PdfFormFieldAddResetButton(string name, string caption, string value, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
PdfFormFieldAddSelectList(...)
PdfFormFieldAddSignature(string name, float llx, float lly, float urx, float ury)
PdfFormFieldAddSingleLinePasswordField(string name, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
PdfFormFieldAddSingleLineTextField(string name, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
voidDrawButton(PdfFormField button, string caption, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
voidDrawCheckBoxAppearences(PdfFormField field, string value, float llx, float lly, float urx, float ury)
voidDrawMultiLineOfText(PdfFormField field, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
voidDrawRadioAppearences(PdfFormField field, string value, float llx, float lly, float urx, float ury)
voidDrawSignatureAppearences(PdfFormField field, float llx, float lly, float urx, float ury)
voidDrawSingleLineOfText(PdfFormField field, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
PdfFormFieldGetRadioGroup(string name, string defaultValue, bool noToggleToOff)
boolIsValid()
voidSetButtonParams(PdfFormField button, int characteristics, string name, string value)
voidSetCheckBoxParams(PdfFormField field, string name, string value, bool status, float llx, float lly, float urx, float ury)
voidSetChoiceParams(PdfFormField field, string name, string defaultValue, float llx, float lly, float urx, float ury)
voidSetSignatureParams(PdfFormField field, string name, float llx, float lly, float urx, float ury)
voidSetTextFieldParams(PdfFormField field, string text, string name, float llx, float lly, float urx, float ury)
voidToPdf(PdfWriter writer, Stream os)

Details

Inheritance

Constructors

PdfAcroForm

Source code

public PdfAcroForm(PdfWriter writer)
Arguments
TypeNameDescription
PdfWriterwriter

Methods

AddFieldTemplates

Source code

public virtual void AddFieldTemplates(Dictionary<PdfTemplate, object> ft)
Arguments
TypeNameDescription
Dictionary<PdfTemplate, object>ft
AddDocumentField

Source code

public virtual void AddDocumentField(PdfIndirectReference piref)
Arguments
TypeNameDescription
PdfIndirectReferencepiref
IsValid

Source code

public virtual bool IsValid()
AddCalculationOrder

Source code

public virtual void AddCalculationOrder(PdfFormField formField)
Arguments
TypeNameDescription
PdfFormFieldformField
AddFormField

Source code

public virtual void AddFormField(PdfFormField formField)
Arguments
TypeNameDescription
PdfFormFieldformField
AddHtmlPostButton

Source code

public virtual PdfFormField AddHtmlPostButton(string name, string caption, string value, string url, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
stringname
stringcaption
stringvalue
stringurl
BaseFontfont
floatfontSize
floatllx
floatlly
floaturx
floatury
AddResetButton

Source code

public virtual PdfFormField AddResetButton(string name, string caption, string value, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
stringname
stringcaption
stringvalue
BaseFontfont
floatfontSize
floatllx
floatlly
floaturx
floatury
AddMap

Source code

public virtual PdfFormField AddMap(string name, string value, string url, PdfContentByte appearance, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
stringname
stringvalue
stringurl
PdfContentByteappearance
floatllx
floatlly
floaturx
floatury
SetButtonParams

Source code

public virtual void SetButtonParams(PdfFormField button, int characteristics, string name, string value)
Arguments
TypeNameDescription
PdfFormFieldbutton
intcharacteristics
stringname
stringvalue
DrawButton

Source code

public virtual void DrawButton(PdfFormField button, string caption, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
PdfFormFieldbutton
stringcaption
BaseFontfont
floatfontSize
floatllx
floatlly
floaturx
floatury
AddHiddenField

Source code

public virtual PdfFormField AddHiddenField(string name, string value)
Arguments
TypeNameDescription
stringname
stringvalue
AddSingleLineTextField

Source code

public virtual PdfFormField AddSingleLineTextField(string name, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
stringname
stringtext
BaseFontfont
floatfontSize
floatllx
floatlly
floaturx
floatury
AddMultiLineTextField

Source code

public virtual PdfFormField AddMultiLineTextField(string name, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
stringname
stringtext
BaseFontfont
floatfontSize
floatllx
floatlly
floaturx
floatury
AddSingleLinePasswordField

Source code

public virtual PdfFormField AddSingleLinePasswordField(string name, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
stringname
stringtext
BaseFontfont
floatfontSize
floatllx
floatlly
floaturx
floatury
SetTextFieldParams

Source code

public virtual void SetTextFieldParams(PdfFormField field, string text, string name, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
PdfFormFieldfield
stringtext
stringname
floatllx
floatlly
floaturx
floatury
DrawSingleLineOfText

Source code

public virtual void DrawSingleLineOfText(PdfFormField field, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
PdfFormFieldfield
stringtext
BaseFontfont
floatfontSize
floatllx
floatlly
floaturx
floatury
DrawMultiLineOfText

Source code

public virtual void DrawMultiLineOfText(PdfFormField field, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
PdfFormFieldfield
stringtext
BaseFontfont
floatfontSize
floatllx
floatlly
floaturx
floatury
AddCheckBox

Source code

public virtual PdfFormField AddCheckBox(string name, string value, bool status, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
stringname
stringvalue
boolstatus
floatllx
floatlly
floaturx
floatury
SetCheckBoxParams

Source code

public virtual void SetCheckBoxParams(PdfFormField field, string name, string value, bool status, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
PdfFormFieldfield
stringname
stringvalue
boolstatus
floatllx
floatlly
floaturx
floatury
DrawCheckBoxAppearences

Source code

public virtual void DrawCheckBoxAppearences(PdfFormField field, string value, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
PdfFormFieldfield
stringvalue
floatllx
floatlly
floaturx
floatury
GetRadioGroup

Source code

public virtual PdfFormField GetRadioGroup(string name, string defaultValue, bool noToggleToOff)
Arguments
TypeNameDescription
stringname
stringdefaultValue
boolnoToggleToOff
AddRadioGroup

Source code

public virtual void AddRadioGroup(PdfFormField radiogroup)
Arguments
TypeNameDescription
PdfFormFieldradiogroup
AddRadioButton

Source code

public virtual PdfFormField AddRadioButton(PdfFormField radiogroup, string value, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
PdfFormFieldradiogroup
stringvalue
floatllx
floatlly
floaturx
floatury
DrawRadioAppearences

Source code

public virtual void DrawRadioAppearences(PdfFormField field, string value, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
PdfFormFieldfield
stringvalue
floatllx
floatlly
floaturx
floatury
AddSelectList [1/2]

Source code

public virtual PdfFormField AddSelectList(string name, string[] options, string defaultValue, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
stringname
string``[]options
stringdefaultValue
BaseFontfont
floatfontSize
floatllx
floatlly
floaturx
floatury
AddSelectList [2/2]

Source code

public virtual PdfFormField AddSelectList(string name, string[,] options, string defaultValue, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
stringname
string``[,]options
stringdefaultValue
BaseFontfont
floatfontSize
floatllx
floatlly
floaturx
floatury
AddComboBox [1/2]

Source code

public virtual PdfFormField AddComboBox(string name, string[] options, string defaultValue, bool editable, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
stringname
string``[]options
stringdefaultValue
booleditable
BaseFontfont
floatfontSize
floatllx
floatlly
floaturx
floatury
AddComboBox [2/2]

Source code

public virtual PdfFormField AddComboBox(string name, string[,] options, string defaultValue, bool editable, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
stringname
string``[,]options
stringdefaultValue
booleditable
BaseFontfont
floatfontSize
floatllx
floatlly
floaturx
floatury
SetChoiceParams

Source code

public virtual void SetChoiceParams(PdfFormField field, string name, string defaultValue, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
PdfFormFieldfield
stringname
stringdefaultValue
floatllx
floatlly
floaturx
floatury
AddSignature

Source code

public virtual PdfFormField AddSignature(string name, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
stringname
floatllx
floatlly
floaturx
floatury
SetSignatureParams

Source code

public virtual void SetSignatureParams(PdfFormField field, string name, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
PdfFormFieldfield
stringname
floatllx
floatlly
floaturx
floatury
DrawSignatureAppearences

Source code

public virtual void DrawSignatureAppearences(PdfFormField field, float llx, float lly, float urx, float ury)
Arguments
TypeNameDescription
PdfFormFieldfield
floatllx
floatlly
floaturx
floatury
ToPdf

Source code

public override void ToPdf(PdfWriter writer, Stream os)
Arguments
TypeNameDescription
PdfWriterwriter
Streamos

Properties

NeedAppearances
public virtual bool NeedAppearances { set; }
SigFlags
public virtual int SigFlags { set; }

Generated with ModularDoc

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.