- README
- globals
-
classes
- AcroForm
- ActionBase
- ActionFieldsBase
- ActionGoTo
- ActionGoToR
- ActionJavaScript
- ActionJavaScriptMap
- ActionNamed
- ActionResetForm
- ActionSubmitForm
- ActionUnknown
- ActionURI
- AnnotationBase
- AnnotationCollection
- AnnotationPagesCollection
- BilevelBitmap
- Bitmap
- BmpContext
- Border
- BorderEffect
- Brush
- ButtonAppearance
- CaretAnnotation
- CheckBoxField
- ChoiceField
- CircleAnnotation
- ComboBoxField
- CombTextField
- DefaultAppearance
- Destination
- DestinationBase
- DestinationFit
- DestinationFitB
- DestinationFitBH
- DestinationFitBV
- DestinationFitH
- DestinationFitR
- DestinationFitV
- DestinationRef
- DestinationUnknown
- DestinationXYZ
- DocAction
- DocumentDestinations
- DocumentInfo
- DrawingContext
- DsPdf
- DsPdfConfig
- EmbeddedFileStream
- Field
- FieldCollection
- FieldWidgetCollection
- FileAttachmentAnnotation
- FileSpecification
- FileSpecificationMap
- Font
- FontCollection
- FontHandler
- FontHandlerCollection
- Format
- FreeTextAnnotation
- GraphicsPath
- GrayscaleBitmap
- HatchBrush
- Image
- ImageBrush
- InkAnnotation
- Layout
- LineAnnotation
- LinearGradientBrush
- LinkAnnotation
- ListBoxField
- MarkupAnnotation
- Metadata
- ObjectBase
- ObjectManager
- OutlineNode
- OutlineNodeCollection
- PdfContext
- PdfDocument
- PdfImageHandler
- PdfImageHandlerCollection
- PdfPage
- PdfPageCollection
- Pen
- PolygonAnnotation
- PolygonAnnotationBase
- PolyLineAnnotation
- PopupAnnotation
- PushButtonField
- RadialGradientBrush
- RadioButtonField
- RedactAnnotation
- RichMediaAnnotation
- Security
- SecurityHandlerBase
- SignatureField
- SolidBrush
- SoundAnnotation
- SoundObject
- SplitOptions
- SquareAnnotation
- StampAnnotation
- StandardSecurityHandler
- StandardSecurityHandlerRev2
- StandardSecurityHandlerRev3
- StandardSecurityHandlerRev4
- StandardSecurityHandlerRev5
- StandardSecurityHandlerRev6
- SvgContext
- SvgDocument
- TextAnnotation
- TextField
- TextMarkupAnnotation
- Transform
- UnknownAnnotation
- UnknownSecurityHandler
- WatermarkAnnotation
- WidgetAnnotation
- enumerations
- functions
- type-aliases
FieldCollection
DsPdfJS API / FieldCollection
Class: FieldCollection
Represents a collection of Field objects.
Extends
PdfCollection<Field>
Accessors
count
Get Signature
get count():
number
Gets the number of items in the collection.
Returns
number
Overrides
PdfCollection.count
doc
Get Signature
get doc():
PdfDocument
Gets the PdfDocument object that owns this collection.
Returns
field
Get Signature
get field():
Field|null
Gets the Field object that owns this collection.
Returns
Field | null
id
Get Signature
get id():
number
Gets the reference to the object.
Returns
number
Inherited from
PdfCollection.id
last
Get Signature
get last():
TItem|null
Gets last item in the collection.
Returns
TItem | null
Inherited from
PdfCollection.last
om
Get Signature
get om():
ObjectManager
Gets the owner ObjectManager instance.
Returns
Inherited from
PdfCollection.om
Methods
add()
add(
item):void
Adds an item to the end of the collection.
Parameters
item
The item to add.
Returns
void
Overrides
PdfCollection.add
clear()
clear():
void
Clears the collection.
Returns
void
Overrides
PdfCollection.clear
contains()
contains(
item):boolean
Determines whether the item is in the collection.
Parameters
item
Returns
boolean
true if the item is in the collection, false otherwise.
Overrides
PdfCollection.contains
findByName()
findByName(
name):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):Field
Gets the item with the specified index.
Parameters
index
number
The index of the item.
Returns
Overrides
PdfCollection.getAt
getByName()
getByName(
name):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
- Returns found Field, throws an exception if not found.
insert()
insert(
index,item):void
Inserts an item at a specific position in the collection.
Parameters
index
number
The position where the item will be inserted.
item
The item to insert.
Returns
void
Overrides
PdfCollection.insert
rebind()
rebind(
omTo):void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
omTo
The new ObjectManager for the object.
Returns
void
Inherited from
PdfCollection.rebind
remove()
remove(
item):boolean
Removes the specified item from the collection.
Parameters
item
The item to remove.
Returns
boolean
true if the item was actually removed, false otherwise.
Overrides
PdfCollection.remove
removeAt()
removeAt(
index):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,item):void
Sets the item at the specified index.
Parameters
index
number
The index of the item, starting from 0.
item
The object to set.
Returns
void
Overrides
PdfCollection.setAt