Class PdfSignatureDictionary

PDF signature dictionary containing all signature-related entries. Manages the ByteRange and Contents fields with appropriate placeholder sizing.

Hierarchy (View Summary)

PdfDictionary<PdfSignatureDictionaryEntries>
- PdfSignatureDictionary

Index

Constructors

constructor

new PdfSignatureDictionary(
    entries: Omit<PdfSignatureDictionaryEntries, "Contents" | "ByteRange"> & {
        ByteRange?: PdfArray<PdfNumber>;
        Contents?: PdfHexadecimal;
    },
): PdfSignatureDictionary
Creates a new signature dictionary.
Parameters
- entries: Omit<PdfSignatureDictionaryEntries, "Contents" | "ByteRange"> & {
  ByteRange?: PdfArray<PdfNumber>;
  Contents?: PdfHexadecimal;
  }
  The signature dictionary entries, ByteRange and Contents are auto-populated if not provided.
Returns PdfSignatureDictionary
Overrides PdfDictionary.constructor
- Defined in packages/pdf-lite/src/signing/signatures/base.ts:37

Properties

innerTokens

innerTokens: PdfToken[] = []

`Protected`modified

modified: boolean = true

Indicates whether the object has been modified. By default, assume it has been modified because it's a new object

`Optional`postTokens

postTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Optional`preTokens

preTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

Accessors

objectType

get objectType(): string
The type of this PDF object

Returns string
Inherited from PdfDictionary.objectType
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:17

values

get values(): { readonly [K in string]: T[K] }
Returns { readonly [K in string]: T[K] }
Inherited from PdfDictionary.values
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:94

Methods

as

as<T extends PdfObject>(ctor: new (...args: any[]) => T): T
Attempts to cast the object to a specific PdfObject subclass
Type Parameters
- T extends PdfObject
Parameters
- ctor: new (...args: any[]) => T
Returns T
Inherited from PdfDictionary.as
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:65

clone

clone(): this
Creates a deep clone of the object

Returns this
Inherited from PdfDictionary.clone
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:157

copyFrom

copyFrom(other: PdfDictionary<any>): void
Parameters
- other: PdfDictionary<any>
Returns void
Inherited from PdfDictionary.copyFrom
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:150

delete

delete<K extends keyof PdfSignatureDictionaryEntries>(key: K | PdfName<K>): void
Type Parameters
- K extends keyof PdfSignatureDictionaryEntries
Parameters
- key: K | PdfName<K>
Returns void
Inherited from PdfDictionary.delete
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:63

equals

equals(other?: PdfObject): boolean
Compares this object to another for equality based on their token representations
Parameters
- Optionalother: PdfObject
Returns boolean
Inherited from PdfDictionary.equals
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:79

get

get<K extends keyof PdfSignatureDictionaryEntries>(
key: K | PdfName<K>,
): PdfSignatureDictionaryEntries[K] | undefined
Type Parameters
- K extends keyof PdfSignatureDictionaryEntries
Parameters
- key: K | PdfName<K>
Returns PdfSignatureDictionaryEntries[K] | undefined
Inherited from PdfDictionary.get
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:29

has

has<K extends keyof PdfSignatureDictionaryEntries>(key: K | PdfName<K>): boolean
Type Parameters
- K extends keyof PdfSignatureDictionaryEntries
Parameters
- key: K | PdfName<K>
Returns boolean
Inherited from PdfDictionary.has
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:81

isModified

isModified(): boolean
Indicates whether the object has been modified. Override this method if the modified state is determined differently

Returns boolean
Inherited from PdfDictionary.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:165

set

set<K extends keyof PdfSignatureDictionaryEntries>(
key: K | PdfName<K>,
value: PdfSignatureDictionaryEntries[K],
): void
Type Parameters
- K extends keyof PdfSignatureDictionaryEntries
Parameters
- key: K | PdfName<K>
- value: PdfSignatureDictionaryEntries[K]
Returns void
Inherited from PdfDictionary.set
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:43

setModified

setModified(modified?: boolean): void
Sets the modified state of the object. Override this method if the modified state is determined differently
Parameters
- modified: boolean = true
Returns void
Inherited from PdfDictionary.setModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:27

toBytes

toBytes(padTo?: number): ByteArray
Converts the object to a ByteArray, optionally padding to a specified length
Parameters
- OptionalpadTo: number
Returns ByteArray
Inherited from PdfDictionary.toBytes
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:41

`Protected`tokenize

tokenize(): PdfToken[]
Tokenizes the object into an array of PdfTokens

Returns PdfToken[]
Inherited from PdfDictionary.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:107

toString

toString(): string
Converts the object to a string representation

Returns string
Inherited from PdfDictionary.toString
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:56

toTokens

toTokens(): PdfToken[]
Converts the object to an array of PdfTokens, including any pre or post tokens

Returns PdfToken[]
Inherited from PdfDictionary.toTokens
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:32

Class PdfSignatureDictionary

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfSignatureDictionary

Properties

innerTokens

Protectedmodified

OptionalpostTokens

OptionalpreTokens

Accessors

objectType

Returns string

values

Returns { readonly [K in string]: T[K] }

Methods

as

Type Parameters

Parameters

Returns T

clone

Returns this

copyFrom

Parameters

Returns void

delete

Type Parameters

Parameters

Returns void

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

Returns PdfSignatureDictionaryEntries[K] | undefined

has

Type Parameters

Parameters

Returns boolean

isModified

Returns boolean

set

Type Parameters

Parameters

Returns void

setModified

Parameters

Returns void

toBytes

Parameters

Returns ByteArray

Protectedtokenize

Returns PdfToken[]

toString

Returns string

toTokens

Returns PdfToken[]

Settings

On This Page

`Protected`modified

`Optional`postTokens

`Optional`preTokens

`Protected`tokenize