iText 5

AcroFields (1)

AcroFields Public class

Diagram

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

Members

Properties

Public properties

Type

Name

Methods

IDictionary<string,

TextField

>

FieldCache

get, set

IDictionary<string, Item>

Fields

get

bool

GenerateAppearances

get, set

List<

BaseFont

>

SubstitutionFonts

get, set

int

TotalRevisions

get

XfaForm

Xfa

get

Methods

Public Static methods

Returns

Name

object``[]

SplitDAelements

(string da)

Internal methods
Public methods

Returns

Name

void

AddSubstitutionFont

(

BaseFont

font)

bool

ClearSignatureField

(string name)

void

DecodeGenericDictionary

(

PdfDictionary

merged,

BaseField

tx)

bool

DoesSignatureFieldExist

(string name)

void

ExportAsFdf

(

FdfWriter

writer)

Stream

ExtractRevision

(string field)

string``[]

GetAppearanceStates

(string fieldName)

List<string>

GetBlankSignatureNames

()

string

GetField

(string name)

Item

GetFieldItem

(string name)

IList<FieldPosition>

GetFieldPositions

(string name)

string

GetFieldRichValue

(string name)

int

GetFieldType

(string fieldName)

string``[]

GetListOptionDisplay

(string fieldName)

string``[]

GetListOptionExport

(string fieldName)

string``[]

GetListSelection

(string name)

PushbuttonField

GetNewPushbuttonFromField

(...)

PdfIndirectReference

GetNormalAppearance

(string name)

int

GetRevision

(string field)

PdfDictionary

GetSignatureDictionary

(string name)

List<string>

GetSignatureNames

()

string

GetTranslatedFieldName

(string name)

void

MergeXfaData

(XmlNode n)

bool

RegenerateField

(string name)

bool

RemoveField

(...)

bool

RemoveFieldsFromPage

(int page)

void

RemoveXfa

()

bool

RenameField

(string oldName, string newName)

bool

ReplacePushbuttonField

(...)

void

SetExtraMargin

(float extraMarginLeft, float extraMarginTop)

bool

SetField

(...)

bool

SetFieldProperty

(...)

bool

SetFieldRichValue

(string name, string richValue)

void

SetFields

(...)

bool

SetListOption

(string fieldName, string``[] exportValues, string``[] displayValues)

bool

SetListSelection

(string name, string``[] value)

bool

SignatureCoversWholeDocument

(string name)

PdfPKCS7

VerifySignature

(string name)

Details

Nested types

Classes
  • Item

  • FieldPosition

Constructors

AcroFields

Source code

internal AcroFields(PdfReader reader, PdfWriter writer)

Arguments

Type

Name

Description

PdfReader

reader

PdfWriter

writer

Methods

SplitDAelements

Source code

public static object SplitDAelements(string da)

Arguments

Type

Name

Description

string

da

Fill

Source code

internal void Fill()

GetAppearanceStates

Source code

public virtual string GetAppearanceStates(string fieldName)

Arguments

Type

Name

Description

string

fieldName

GetListOptionExport

Source code

public virtual string GetListOptionExport(string fieldName)

Arguments

Type

Name

Description

string

fieldName

GetListOptionDisplay

Source code

public virtual string GetListOptionDisplay(string fieldName)

Arguments

Type

Name

Description

string

fieldName

SetListOption

Source code

public virtual bool SetListOption(string fieldName, string[] exportValues, string[] displayValues)

Arguments

Type

Name

Description

string

fieldName

string``[]

exportValues

string``[]

displayValues

GetFieldType

Source code

public virtual int GetFieldType(string fieldName)

Arguments

Type

Name

Description

string

fieldName

ExportAsFdf

Source code

public virtual void ExportAsFdf(FdfWriter writer)

Arguments

Type

Name

Description

FdfWriter

writer

RenameField

Source code

public virtual bool RenameField(string oldName, string newName)

Arguments

Type

Name

Description

string

oldName

string

newName

DecodeGenericDictionary

Source code

public virtual void DecodeGenericDictionary(PdfDictionary merged, BaseField tx)

Arguments

Type

Name

Description

PdfDictionary

merged

BaseField

tx

GetAppearance [1/2]

Source code

internal PdfAppearance GetAppearance(PdfDictionary merged, string[] values, string fieldName)

Arguments

Type

Name

Description

PdfDictionary

merged

string``[]

values

string

fieldName

GetAppearance [2/2]

Source code

internal PdfAppearance GetAppearance(PdfDictionary merged, string text, string fieldName)

Arguments

Type

Name

Description

PdfDictionary

merged

string

text

string

fieldName

GetMKColor

Source code

internal BaseColor GetMKColor(PdfArray ar)

Arguments

Type

Name

Description

PdfArray

ar

GetFieldRichValue

Source code

public virtual string GetFieldRichValue(string name)

Arguments

Type

Name

Description

string

name

GetField

Source code

public virtual string GetField(string name)

Arguments

Type

Name

Description

string

name

GetListSelection

Source code

public virtual string GetListSelection(string name)

Arguments

Type

Name

Description

string

name

SetFieldProperty [1/2]

Source code

public virtual bool SetFieldProperty(string field, string name, object value, int[] inst)

Arguments

Type

Name

Description

string

field

string

name

object

value

int``[]

inst

SetFieldProperty [2/2]

Source code

public virtual bool SetFieldProperty(string field, string name, int value, int[] inst)

Arguments

Type

Name

Description

string

field

string

name

int

value

int``[]

inst

MergeXfaData

Source code

public virtual void MergeXfaData(XmlNode n)

Arguments

Type

Name

Description

XmlNode

n

SetFields [1/2]

Source code

public virtual void SetFields(FdfReader fdf)

Arguments

Type

Name

Description

FdfReader

fdf

SetFields [2/2]

Source code

public virtual void SetFields(XfdfReader xfdf)

Arguments

Type

Name

Description

XfdfReader

xfdf

RegenerateField

Source code

public virtual bool RegenerateField(string name)

Arguments

Type

Name

Description

string

name

SetField [1/4]

Source code

public virtual bool SetField(string name, string value)

Arguments

Type

Name

Description

string

name

string

value

SetField [2/4]

Source code

public virtual bool SetField(string name, string value, bool saveAppearance)

Arguments

Type

Name

Description

string

name

string

value

bool

saveAppearance

SetFieldRichValue

Source code

public virtual bool SetFieldRichValue(string name, string richValue)

Arguments

Type

Name

Description

string

name

string

richValue

SetField [3/4]

Source code

public virtual bool SetField(string name, string value, string display)

Arguments

Type

Name

Description

string

name

string

value

string

display

SetField [4/4]

Source code

public virtual bool SetField(string name, string value, string display, bool saveAppearance)

Arguments

Type

Name

Description

string

name

string

value

string

display

bool

saveAppearance

SetListSelection

Source code

public virtual bool SetListSelection(string name, string[] value)

Arguments

Type

Name

Description

string

name

string``[]

value

IsInAP

Source code

internal bool IsInAP(PdfDictionary nDic, PdfName check)

Arguments

Type

Name

Description

PdfDictionary

nDic

PdfName

check

GetFieldItem

Source code

public virtual Item GetFieldItem(string name)

Arguments

Type

Name

Description

string

name

GetTranslatedFieldName

Source code

public virtual string GetTranslatedFieldName(string name)

Arguments

Type

Name

Description

string

name

GetFieldPositions

Source code

public virtual IList<FieldPosition> GetFieldPositions(string name)

Arguments

Type

Name

Description

string

name

RemoveFieldsFromPage

Source code

public virtual bool RemoveFieldsFromPage(int page)

Arguments

Type

Name

Description

int

page

RemoveField [1/2]

Source code

public virtual bool RemoveField(string name, int page)

Arguments

Type

Name

Description

string

name

int

page

RemoveField [2/2]

Source code

public virtual bool RemoveField(string name)

Arguments

Type

Name

Description

string

name

ClearSignatureField

Source code

public virtual bool ClearSignatureField(string name)

Arguments

Type

Name

Description

string

name

GetSignatureNames

Source code

public virtual List<string> GetSignatureNames()

GetBlankSignatureNames

Source code

public virtual List<string> GetBlankSignatureNames()

GetSignatureDictionary

Source code

public virtual PdfDictionary GetSignatureDictionary(string name)

Arguments

Type

Name

Description

string

name

GetNormalAppearance

Source code

public virtual PdfIndirectReference GetNormalAppearance(string name)

Arguments

Type

Name

Description

string

name

SignatureCoversWholeDocument

Source code

public virtual bool SignatureCoversWholeDocument(string name)

Arguments

Type

Name

Description

string

name

VerifySignature

Source code

public virtual PdfPKCS7 VerifySignature(string name)

Arguments

Type

Name

Description

string

name

GetRevision

Source code

public virtual int GetRevision(string field)

Arguments

Type

Name

Description

string

field

ExtractRevision

Source code

public virtual Stream ExtractRevision(string field)

Arguments

Type

Name

Description

string

field

SetExtraMargin

Source code

public virtual void SetExtraMargin(float extraMarginLeft, float extraMarginTop)

Arguments

Type

Name

Description

float

extraMarginLeft

float

extraMarginTop

AddSubstitutionFont

Source code

public virtual void AddSubstitutionFont(BaseFont font)

Arguments

Type

Name

Description

BaseFont

font

RemoveXfa

Source code

public virtual void RemoveXfa()

GetNewPushbuttonFromField [1/2]

Source code

public virtual PushbuttonField GetNewPushbuttonFromField(string field)

Arguments

Type

Name

Description

string

field

GetNewPushbuttonFromField [2/2]

Source code

public virtual PushbuttonField GetNewPushbuttonFromField(string field, int order)

Arguments

Type

Name

Description

string

field

int

order

ReplacePushbuttonField [1/2]

Source code

public virtual bool ReplacePushbuttonField(string field, PdfFormField button)

Arguments

Type

Name

Description

string

field

PdfFormField

button

ReplacePushbuttonField [2/2]

Source code

public virtual bool ReplacePushbuttonField(string field, PdfFormField button, int order)

Arguments

Type

Name

Description

string

field

PdfFormField

button

int

order

DoesSignatureFieldExist

Source code

public virtual bool DoesSignatureFieldExist(string name)

Arguments

Type

Name

Description

string

name

Properties

Fields

public virtual IDictionary<string, Item> Fields { get; }

GenerateAppearances

public virtual bool GenerateAppearances { get; set; }

TotalRevisions

public virtual int TotalRevisions { get; }

FieldCache

public virtual IDictionary<string, TextField> FieldCache { get; set; }

SubstitutionFonts

public virtual List<BaseFont> SubstitutionFonts { get; set; }

Xfa

public virtual XfaForm Xfa { get; }

Generated with ModularDoc