Class PdfName<T>

Type Parameters

T extends string = string

Hierarchy (View Summary)

PdfObject
- PdfName

Index

Constructors

Properties

modified postTokens? preTokens? value

Accessors

Methods

as clone equals isModified setModified toBytes tokenize toString toTokens

Constructors

constructor

new PdfName<T extends string = string>(value: T): PdfName<T>
Type Parameters
- T extends string = string
Parameters
- value: T
Returns PdfName<T>
Overrides PdfObject.constructor
- Defined in packages/pdf-lite/src/core/objects/pdf-name.ts:7

Properties

`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

value

value: T

Accessors

objectType

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

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

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 PdfObject.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
Overrides PdfObject.clone
- Defined in packages/pdf-lite/src/core/objects/pdf-name.ts:16

equals

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

isModified

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

Returns boolean
Inherited from PdfObject.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:22

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 PdfObject.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 PdfObject.toBytes
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:41

`Protected`tokenize

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

Returns PdfNameToken[]
Overrides PdfObject.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-name.ts:12

toString

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

Returns string
Inherited from PdfObject.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 PdfObject.toTokens
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:32