iText 5

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

Type

Name

Methods

bool

NeedAppearances

set

int

SigFlags

set

Methods

Public methods

Returns

Name

void

AddCalculationOrder

(

PdfFormField

formField)

PdfFormField

AddCheckBox

(string name, string value, bool status, float llx, float lly, float urx, float ury)

PdfFormField

AddComboBox

(...)

void

AddDocumentField

(

PdfIndirectReference

piref)

void

AddFieldTemplates

(Dictionary<

PdfTemplate

, object> ft)

void

AddFormField

(

PdfFormField

formField)

PdfFormField

AddHiddenField

(string name, string value)

PdfFormField

AddHtmlPostButton

(string name, string caption, string value, string url,

BaseFont

font, float fontSize, float llx, float lly, float urx, float ury)

PdfFormField

AddMap

(string name, string value, string url,

PdfContentByte

appearance, float llx, float lly, float urx, float ury)

PdfFormField

AddMultiLineTextField

(string name, string text,

BaseFont

font, float fontSize, float llx, float lly, float urx, float ury)

PdfFormField

AddRadioButton

(

PdfFormField

radiogroup, string value, float llx, float lly, float urx, float ury)

void

AddRadioGroup

(

PdfFormField

radiogroup)

PdfFormField

AddResetButton

(string name, string caption, string value,

BaseFont

font, float fontSize, float llx, float lly, float urx, float ury)

PdfFormField

AddSelectList

(...)

PdfFormField

AddSignature

(string name, float llx, float lly, float urx, float ury)

PdfFormField

AddSingleLinePasswordField

(string name, string text,

BaseFont

font, float fontSize, float llx, float lly, float urx, float ury)

PdfFormField

AddSingleLineTextField

(string name, string text,

BaseFont

font, float fontSize, float llx, float lly, float urx, float ury)

void

DrawButton

(

PdfFormField

button, string caption,

BaseFont

font, float fontSize, float llx, float lly, float urx, float ury)

void

DrawCheckBoxAppearences

(

PdfFormField

field, string value, float llx, float lly, float urx, float ury)

void

DrawMultiLineOfText

(

PdfFormField

field, string text,

BaseFont

font, float fontSize, float llx, float lly, float urx, float ury)

void

DrawRadioAppearences

(

PdfFormField

field, string value, float llx, float lly, float urx, float ury)

void

DrawSignatureAppearences

(

PdfFormField

field, float llx, float lly, float urx, float ury)

void

DrawSingleLineOfText

(

PdfFormField

field, string text,

BaseFont

font, float fontSize, float llx, float lly, float urx, float ury)

PdfFormField

GetRadioGroup

(string name, string defaultValue, bool noToggleToOff)

bool

IsValid

()

void

SetButtonParams

(

PdfFormField

button, int characteristics, string name, string value)

void

SetCheckBoxParams

(

PdfFormField

field, string name, string value, bool status, float llx, float lly, float urx, float ury)

void

SetChoiceParams

(

PdfFormField

field, string name, string defaultValue, float llx, float lly, float urx, float ury)

void

SetSignatureParams

(

PdfFormField

field, string name, float llx, float lly, float urx, float ury)

void

SetTextFieldParams

(

PdfFormField

field, string text, string name, float llx, float lly, float urx, float ury)

void

ToPdf

(

PdfWriter

writer, Stream os)

Details

Inheritance

Constructors

PdfAcroForm

Source code

public PdfAcroForm(PdfWriter writer)

Arguments

Type

Name

Description

PdfWriter

writer

Methods

AddFieldTemplates

Source code

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

Arguments

Type

Name

Description

Dictionary<

PdfTemplate

, object>

ft

AddDocumentField

Source code

public virtual void AddDocumentField(PdfIndirectReference piref)

Arguments

Type

Name

Description

PdfIndirectReference

piref

IsValid

Source code

public virtual bool IsValid()

AddCalculationOrder

Source code

public virtual void AddCalculationOrder(PdfFormField formField)

Arguments

Type

Name

Description

PdfFormField

formField

AddFormField

Source code

public virtual void AddFormField(PdfFormField formField)

Arguments

Type

Name

Description

PdfFormField

formField

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

Type

Name

Description

string

name

string

caption

string

value

string

url

BaseFont

font

float

fontSize

float

llx

float

lly

float

urx

float

ury

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

Type

Name

Description

string

name

string

caption

string

value

BaseFont

font

float

fontSize

float

llx

float

lly

float

urx

float

ury

AddMap

Source code

public virtual PdfFormField AddMap(string name, string value, string url, PdfContentByte appearance, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

string

name

string

value

string

url

PdfContentByte

appearance

float

llx

float

lly

float

urx

float

ury

SetButtonParams

Source code

public virtual void SetButtonParams(PdfFormField button, int characteristics, string name, string value)

Arguments

Type

Name

Description

PdfFormField

button

int

characteristics

string

name

string

value

DrawButton

Source code

public virtual void DrawButton(PdfFormField button, string caption, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

PdfFormField

button

string

caption

BaseFont

font

float

fontSize

float

llx

float

lly

float

urx

float

ury

AddHiddenField

Source code

public virtual PdfFormField AddHiddenField(string name, string value)

Arguments

Type

Name

Description

string

name

string

value

AddSingleLineTextField

Source code

public virtual PdfFormField AddSingleLineTextField(string name, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

string

name

string

text

BaseFont

font

float

fontSize

float

llx

float

lly

float

urx

float

ury

AddMultiLineTextField

Source code

public virtual PdfFormField AddMultiLineTextField(string name, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

string

name

string

text

BaseFont

font

float

fontSize

float

llx

float

lly

float

urx

float

ury

AddSingleLinePasswordField

Source code

public virtual PdfFormField AddSingleLinePasswordField(string name, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

string

name

string

text

BaseFont

font

float

fontSize

float

llx

float

lly

float

urx

float

ury

SetTextFieldParams

Source code

public virtual void SetTextFieldParams(PdfFormField field, string text, string name, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

PdfFormField

field

string

text

string

name

float

llx

float

lly

float

urx

float

ury

DrawSingleLineOfText

Source code

public virtual void DrawSingleLineOfText(PdfFormField field, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

PdfFormField

field

string

text

BaseFont

font

float

fontSize

float

llx

float

lly

float

urx

float

ury

DrawMultiLineOfText

Source code

public virtual void DrawMultiLineOfText(PdfFormField field, string text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

PdfFormField

field

string

text

BaseFont

font

float

fontSize

float

llx

float

lly

float

urx

float

ury

AddCheckBox

Source code

public virtual PdfFormField AddCheckBox(string name, string value, bool status, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

string

name

string

value

bool

status

float

llx

float

lly

float

urx

float

ury

SetCheckBoxParams

Source code

public virtual void SetCheckBoxParams(PdfFormField field, string name, string value, bool status, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

PdfFormField

field

string

name

string

value

bool

status

float

llx

float

lly

float

urx

float

ury

DrawCheckBoxAppearences

Source code

public virtual void DrawCheckBoxAppearences(PdfFormField field, string value, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

PdfFormField

field

string

value

float

llx

float

lly

float

urx

float

ury

GetRadioGroup

Source code

public virtual PdfFormField GetRadioGroup(string name, string defaultValue, bool noToggleToOff)

Arguments

Type

Name

Description

string

name

string

defaultValue

bool

noToggleToOff

AddRadioGroup

Source code

public virtual void AddRadioGroup(PdfFormField radiogroup)

Arguments

Type

Name

Description

PdfFormField

radiogroup

AddRadioButton

Source code

public virtual PdfFormField AddRadioButton(PdfFormField radiogroup, string value, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

PdfFormField

radiogroup

string

value

float

llx

float

lly

float

urx

float

ury

DrawRadioAppearences

Source code

public virtual void DrawRadioAppearences(PdfFormField field, string value, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

PdfFormField

field

string

value

float

llx

float

lly

float

urx

float

ury

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

Type

Name

Description

string

name

string``[]

options

string

defaultValue

BaseFont

font

float

fontSize

float

llx

float

lly

float

urx

float

ury

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

Type

Name

Description

string

name

string``[,]

options

string

defaultValue

BaseFont

font

float

fontSize

float

llx

float

lly

float

urx

float

ury

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

Type

Name

Description

string

name

string``[]

options

string

defaultValue

bool

editable

BaseFont

font

float

fontSize

float

llx

float

lly

float

urx

float

ury

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

Type

Name

Description

string

name

string``[,]

options

string

defaultValue

bool

editable

BaseFont

font

float

fontSize

float

llx

float

lly

float

urx

float

ury

SetChoiceParams

Source code

public virtual void SetChoiceParams(PdfFormField field, string name, string defaultValue, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

PdfFormField

field

string

name

string

defaultValue

float

llx

float

lly

float

urx

float

ury

AddSignature

Source code

public virtual PdfFormField AddSignature(string name, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

string

name

float

llx

float

lly

float

urx

float

ury

SetSignatureParams

Source code

public virtual void SetSignatureParams(PdfFormField field, string name, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

PdfFormField

field

string

name

float

llx

float

lly

float

urx

float

ury

DrawSignatureAppearences

Source code

public virtual void DrawSignatureAppearences(PdfFormField field, float llx, float lly, float urx, float ury)

Arguments

Type

Name

Description

PdfFormField

field

float

llx

float

lly

float

urx

float

ury

ToPdf

Source code

public override void ToPdf(PdfWriter writer, Stream os)

Arguments

Type

Name

Description

PdfWriter

writer

Stream

os

Properties

NeedAppearances

public virtual bool NeedAppearances { set; }

SigFlags

public virtual int SigFlags { set; }

Generated with ModularDoc