Class FieldCollection

Represents a collection of Field objects.

Hierarchy

PdfCollection<Field>
- FieldCollection

Index

Accessors

count doc field id last om

Methods

add clear contains findByName free getAt getByName insert rebind remove removeAt setAt

Accessors

count

get count(): number
Gets the number of items in the collection.

Returns number
Overrides PdfCollection.count

doc

get doc(): PdfDocument
Gets the PdfDocument object that owns this collection.

Returns PdfDocument

field

get field(): Field | null
Gets the Field object that owns this collection.

Returns Field | null

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from PdfCollection.id

last

get last(): TItem | null
Gets last item in the collection.

Returns TItem | null
Inherited from PdfCollection.last

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from PdfCollection.om

Methods

add

add(item: Field | FieldProperties): void
Adds an item to the end of the collection.
Parameters
- item: Field | FieldProperties
  The item to add.
Returns void
Overrides PdfCollection.add

clear

clear(): void
Clears the collection.

Returns void
Overrides PdfCollection.clear

contains

contains(item: Field): boolean
Determines whether the item is in the collection.
Parameters
- item: Field
Returns boolean
true if the item is in the collection, false otherwise.

Overrides PdfCollection.contains

findByName

findByName(name: string): Field | null
Searches Field with specified name, search is case sensitive.
Parameters
- name: string
  The field's name.
Returns Field | null
- Returns found Field or null if not found.

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from PdfCollection.free

getAt

getAt(index: number): Field
Gets the item with the specified index.
Parameters
- index: number
  The index of the item.
Returns Field
Overrides PdfCollection.getAt

getByName

getByName(name: string): Field
Searches Field with specified name, search is case sensitive, throws an exception if a field not found.
Parameters
- name: string
  The field's name.
Returns Field
- Returns found Field, throws an exception if not found.

insert

insert(index: number, item: Field | FieldProperties): void
Inserts an item at a specific position in the collection.
Parameters
- index: number
  The position where the item will be inserted.
- item: Field | FieldProperties
  The item to insert.
Returns void
Overrides PdfCollection.insert

rebind

rebind(omTo: ObjectManager): void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
- omTo: ObjectManager
  The new ObjectManager for the object.
Returns void
Inherited from PdfCollection.rebind

remove

remove(item: Field): boolean
Removes the specified item from the collection.
Parameters
- item: Field
  The item to remove.
Returns boolean
true if the item was actually removed, false otherwise.

Overrides PdfCollection.remove

removeAt

removeAt(index: number): void
Removes the item at specified index.
Parameters
- index: number
  The index of the item to remove.
Returns void
Overrides PdfCollection.removeAt

setAt

setAt(index: number, item: Field): void
Sets the item at the specified index.
Parameters
- index: number
  The index of the item, starting from 0.
- item: Field
  The object to set.
Returns void
Overrides PdfCollection.setAt