happypdf / PDFAcroField

Class: PDFAcroField

Defined in: src/core/acroform/PDFAcroField.ts:18

Extended by

• PDFAcroNonTerminal
• PDFAcroTerminal

Constructors

Constructor

protected new PDFAcroField(dict, ref): PDFAcroField;

Defined in: src/core/acroform/PDFAcroField.ts:22

Parameters

Parameter	Type
dict	PDFDict
ref	PDFRef

Returns

PDFAcroField

Properties

dict

readonly dict: PDFDict;

Defined in: src/core/acroform/PDFAcroField.ts:19

---

ref

readonly ref: PDFRef;

Defined in: src/core/acroform/PDFAcroField.ts:20

Methods

ascend()

ascend(visitor): void;

Defined in: src/core/acroform/PDFAcroField.ts:160

Parameters

Parameter	Type
visitor	(node) => any

Returns

void

---

clearFlag()

clearFlag(flag): void;

Defined in: src/core/acroform/PDFAcroField.ts:142

Parameters

Parameter	Type
flag	number

Returns

void

---

DA()

DA(): 
  | PDFHexString
  | PDFString
  | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:49

Returns

| PDFHexString | PDFString | undefined

---

Ff()

Ff(): PDFNumber | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:31

Returns

PDFNumber | undefined

---

getDefaultAppearance()

getDefaultAppearance(): string | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:97

Returns

string | undefined

---

getFlags()

getFlags(): number;

Defined in: src/core/acroform/PDFAcroField.ts:124

Returns

number

---

getFullyQualifiedName()

getFullyQualifiedName(): string | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:78

Returns

string | undefined

---

getInheritableAttribute()

getInheritableAttribute(name): PDFObject | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:152

Parameters

Parameter	Type
name	PDFName

Returns

PDFObject | undefined

---

getParent()

getParent(): PDFAcroField | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:59

Returns

PDFAcroField | undefined

---

getPartialName()

getPartialName(): string | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:84

Returns

string | undefined

---

hasFlag()

hasFlag(flag): boolean;

Defined in: src/core/acroform/PDFAcroField.ts:132

Parameters

Parameter	Type
flag	number

Returns

boolean

---

Kids()

Kids(): PDFArray | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:41

Returns

PDFArray | undefined

---

setDefaultAppearance()

setDefaultAppearance(appearance): void;

Defined in: src/core/acroform/PDFAcroField.ts:93

Parameters

Parameter	Type
appearance	string

Returns

void

---

setFlag()

setFlag(flag): void;

Defined in: src/core/acroform/PDFAcroField.ts:137

Parameters

Parameter	Type
flag	number

Returns

void

---

setFlags()

setFlags(flags): void;

Defined in: src/core/acroform/PDFAcroField.ts:128

Parameters

Parameter	Type
flags	number

Returns

void

---

setFlagTo()

setFlagTo(flag, enable): void;

Defined in: src/core/acroform/PDFAcroField.ts:147

Parameters

Parameter	Type
flag	number
enable	boolean

Returns

void

---

setFontSize()

setFontSize(fontSize): void;

Defined in: src/core/acroform/PDFAcroField.ts:107

Parameters

Parameter	Type
fontSize	number

Returns

void

---

setKids()

setKids(kids): void;

Defined in: src/core/acroform/PDFAcroField.ts:55

Parameters

Parameter	Type
kids	PDFObject[]

Returns

void

---

setParent()

setParent(parent): void;

Defined in: src/core/acroform/PDFAcroField.ts:73

Parameters

Parameter	Type
parent	PDFRef | undefined

Returns

void

---

setPartialName()

setPartialName(partialName): void;

Defined in: src/core/acroform/PDFAcroField.ts:88

Parameters

Parameter	Type
partialName	string | undefined

Returns

void

---

T()

T(): 
  | PDFHexString
  | PDFString
  | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:27

Returns

| PDFHexString | PDFString | undefined

---

V()

V(): PDFObject | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:36

Returns

PDFObject | undefined