Overview

6 Jul 202624 minutes to read

Name Description
Pdf3DAnnotation Pdf3DAnnotation class represents the 3D annotation objects.
PdfAngleMeasurementAnnotation PdfAngleMeasurementAnnotation class represents the angle measurement annotation objects.
PdfAnnotation Represents the base class for annotation objects.
PdfAnnotationBorder PdfAnnotationBorder class represents the border properties of annotations.
PdfAnnotationCaption PdfAnnotationCaption class represents the caption text and properties of annotations.
PdfAnnotationLineEndingStyle PdfAnnotationLineEndingStyle class represents the line ending styles of annotations.
PdfAttachmentAnnotation PdfAttachmentAnnotation class represents the attachment annotation objects.
PdfBorderEffect PdfBorderEffect class represents the border effects of annotations.
PdfCircleAnnotation PdfCircleAnnotation class represents the circle annotation objects.
PdfComment Represents the annotations which have comments and review history.
PdfDocumentLinkAnnotation PdfDocumentLinkAnnotation class represents the document link annotation objects.
PdfEllipseAnnotation PdfEllipseAnnotation class represents the ellipse annotation objects.
PdfFileLinkAnnotation PdfFileLinkAnnotation class represents the link annotation objects.
PdfFreeTextAnnotation PdfFreeTextAnnotation class represents the free text annotation objects.
PdfInkAnnotation PdfInkAnnotation class represents the ink annotation objects.
PdfInteractiveBorder PdfInteractiveBorder class represents the border of the field.
PdfLineAnnotation PdfLineAnnotation class represents the line annotation objects.
PdfListFieldItem PdfListBoxItem class represents the list and combo box field item objects.
PdfPolyLineAnnotation PdfPolyLineAnnotation class represents the polyline annotation objects.
PdfPolygonAnnotation PdfPolygonAnnotation class represents the polygon annotation objects.
PdfPopupAnnotation PdfPopupAnnotation class represents the popup annotation objects.
PdfRadioButtonListItem PdfRadioButtonListItem class represents the radio button field item objects.
PdfRectangleAnnotation PdfRectangleAnnotation class represents the rectangle annotation objects.
PdfRedactionAnnotation PdfRedactionAnnotation class represents the redaction annotation objects.
PdfRichMediaAnnotation PdfRichMediaAnnotation class represents the rich media annotation objects.
PdfRubberStampAnnotation PdfRubberStampAnnotation class represents the rubber stamp annotation objects.
PdfSoundAnnotation PdfSoundAnnotation class represents the sound annotation objects.
PdfSquareAnnotation PdfSquareAnnotation class represents the square annotation objects.
PdfStateItem PdfStateItem class represents the check box field item objects.
PdfTextMarkupAnnotation PdfTextMarkupAnnotation class represents the text markup annotation objects.
PdfTextWebLinkAnnotation PdfTextWebLinkAnnotation class represents the link annotation objects.
PdfUriAnnotation PdfUriAnnotation class represents the URI annotation objects.
PdfWatermarkAnnotation PdfWatermarkAnnotation class represents the watermark annotation objects.
PdfWidgetAnnotation PdfWidgetAnnotation class represents the widget annotation objects.
PdfAnnotationCollection The class provides methods and properties to handle the collection of PdfAnnotation.
PdfPopupAnnotationCollection Represents the collection of PdfPopupAnnotation
PdfAppearance PdfAppearance class represents the appearance of the annotation.
PdfCjkStandardFont Represents one of the 7 CJK standard fonts.
PdfFont Represents the base class for font objects.`
PdfStandardFont Represents one of the 14 standard fonts.
PdfTrueTypeFont Represents TrueType font.
PdfStringFormat Represents the text layout information.
PdfButtonField PdfButtonField class represents the button field objects.
PdfCheckBoxField PdfCheckBoxField class represents the check box field objects.
PdfComboBoxField PdfComboBoxField class represents the combo box field objects.
PdfField PdfField class represents the base class for form field objects.
PdfListBoxField PdfListBoxField class represents the list box field objects.
PdfListField Represents the base class for list box and combo box fields.
PdfRadioButtonListField PdfRadioButtonListField class represents the radio button field objects.
PdfSignatureField PdfSignatureField class represents the signature field objects.
PdfTextBoxField PdfTextBoxField class represents the text box field objects.
PdfForm Represents a PDF form.
PdfAutomaticField Represents an abstract base class for all automatic fields.
PdfCompositeField Represents a composite field that combines multiple automatic fields.
PdfCreationDateField Represents an automatic field that displays the creation date of the document.
PdfDateTimeField Represents an automatic field that displays the current date and time at the time of creation.
PdfDestinationPageNumberField Represents an automatic field that shows the page number of a specified destination page within the document.
PdfDocumentAuthorField Represents an automatic field that displays the document’s author.
PdfDynamicField Represents an abstract class for all dynamic fields.
PdfPageCountField Represents an automatic field that displays the total number of pages in the document.
PdfPageNumberField Represents an automatic field that displays the current page number.
PdfSectionNumberField Represents an automatic field that provides the section number for the current page within the document.
PdfSectionPageCountField Represents an automatic field that displays the total number of pages in the current section.
PdfSectionPageNumberField Represents an automatic field that displays the page number within the current section.
PdfStaticField Represents an abstract class for static field.
PdfBitmap The ‘PdfBitmap’ contains methods and properties to handle the Bitmap images.
PdfImage The ‘PdfImage’ contains methods and properties to handle the images.
PdfGraphics Represents a graphics from a PDF page.
PdfPen Represents a pen for the PDF page.
PdfGraphicsElement Represents an abstract class for elements that can be rendered graphically.
PdfLayoutFormat Represent the layout format class for pagination
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Access the first page
let page: PdfPage = document.getPage(0);
// Create an instance of list item collection by passing the string array
let items: PdfListItemCollection = new PdfListItemCollection([‘Excel’, ‘Power’, ‘Point’, ‘Word’, ‘PDF’]);
// Create a new PDF ordered list
let list: PdfOrderedList = new PdfOrderedList(items);
// Create an instance for PDF layout format
let layout: PdfLayoutFormat = new PdfLayoutFormat();
// Set the layout format
layout.break = PdfLayoutBreakType.fitPage;
layout.layout = pdfLayoutType.paginate;
// Draw the items using specified bounds and layout format
list.draw(page, {x: 0, y: 20}, layout);
// Save the document
document.save(‘output.pdf’);
// Destroy the document
document.destroy();
PdfLayoutResult Represents a class for layout result in PDF generation.
PdfPageTemplateElement Represents a template element for creating and rendering header and footer content in a PDF document.
PdfPath Implements graphics path, which is a sequence of primitive graphics elements.
PdfTemplate PdfTemplate class represents the template of the PDF.
PdfLayer Represents the base class for layer objects.
PdfLayerCollection The class provides methods and properties to handle the collection of PdfLayer.
PdfList Represents base class for lists.
PdfOrderedList Represents an ordered list in a PDF document.
PdfUnorderedList Represents the Unordered lists.
PdfListItem Represents the items of the list.
PdfListItemCollection Represents a collection of list items that can be drawn on a PDF page.
PdfAction Represents base class for all action types.
PdfFieldActions Represents actions to be performed as response to field events.
PdfGoToAction Represents an action which goes to a destination in the current document.
PdfJavaScriptAction Represents a JavaScript action in PDF document.
PdfAnnotationExportSettings Represents annotation export settings.
PdfDocument Represents a PDF document and can be used to parse an existing PDF document.
PdfFormFieldExportSettings Represents form fields export settings.
PdfMargins A class representing PDF page margins.
PdfPageSettings The class provides various settings related to PDF pages.
PdfFileStructure PdfFileStructure class represents the internal structure of the PDF file.
PdfBookmark Represents a bookmark in a PDF document
PdfBookmarkBase Represents a base class for all bookmark objects.
PdfNamedDestination Represents a named destination in a PDF document.
PdfDestination PdfDestination class represents the PDF destination.
PdfPage Represents a page loaded from the PDF document.
PdfPageImportOptions PdfPageImportOptions class represents to customize the support of import PDF pages
PdfSection Represents a PDF section, a set of pages with similar page settings.
PdfSignature ‘PdfSignature’ class represents a digital signature used for signing a PDF document.
BaseException Represents the base class for all custom exceptions.
Provides a message and a name for the exception.
FormatError Represents an error related to invalid format.
Extends BaseException.
ParserEndOfFileException Represents an error thrown when the parser reaches the end of the file unexpectedly.
Extends BaseException.
PdfBasicJobTicketSchema Represents metadata for print job and production instructions.
PdfBasicSchema Represents the Basic Schema.
PdfCustomMetadata Represents the custom metadata for a PDF document.
Provides methods to manage key-value metadata pairs.
PdfCustomSchema Represents a user-defined metadata schema with custom properties.
PdfDublinCoreSchema Represents standard Dublin Core metadata for document description.
PdfPagedTextSchema Represents metadata for paginated text structure in a PDF document.
PdfRightsManagementSchema Represents metadata related to document rights and permissions.
PdfSchema Represents the base schema for PDF document metadata properties.
PdfXmpMetadata Represents the container for all XMP metadata in a PDF document.
PdfXmpSchema Represents core XMP metadata properties for a PDF document.
CryptographicStandard Public enum specifies the cryptographic standard.
DataFormat Public Enum to define export or import data format.
DigestAlgorithm Public enum specifies the message digest algorithm.
PathPointType Public Enum to define the types of points and segments in a path.
PdfAnnotationFlag Public Enum to define annotation flag types.
PdfAnnotationIntent Public Enum to define annotation intent of free text annotation.
PdfAnnotationState Public Enum to define annotation state.
PdfAttachmentIcon Public Enum to define icon type of attachment annotation.
PdfBlendMode Public enum to define blend mode of the PDF page.
PdfBorderEffectStyle Public Enum to define border effect style.
PdfBorderStyle Public Enum to define border style.
PdfCertificationFlags Specifies the certification flags.
PdfCheckBoxStyle Public Enum to define check box style.
PdfCircleMeasurementType Public Enum to define measurement type of circle annotation.
PdfCrossReferenceType Public Enum to define cross reference type.
PdfDashStyle Public enum to define the dash style.
PdfDestinationMode Public Enum to define destination mode of document link annotation.
PdfFillMode Public enum to define fill mode of the PDF page.
PdfFormFieldVisibility Public Enum to define visibility of form field.
PdfFormFieldsTabOrder Public enum to define form fields tab order.
PdfHighlightMode Public Enum to define highlight mode of text box field.
PdfLayoutBreakType Public enum to define a layout Break type for drawing
PdfLayoutType Public enum to define a layout type for drawing
PdfLineCap Public enum to define the line cap.
PdfLineCaptionType Public Enum to define line caption type.
PdfLineEndingStyle Public Enum to define line ending style.
PdfLineIntent Public Enum to define line indent.
PdfLineJoin Public enum to define the line join.
PdfListMarkerAlignment Public enum to define a list marker alignment
PdfMeasurementUnit Public Enum to define measurement unit of line measurement annotation.
PdfNumberStyle Public enum type to represent the ordered list style
PdfPageOrientation Public enum to define the PDF page orientation.
PdfPermissionFlag Public enum to define the PDF document permission flags.
PdfPopupIcon Public Enum to define icon type of popup annotation.
PdfPrintState Public enum to define a print state of layer
PdfRotationAngle Public Enum to define rotation of the interactive elements.
PdfRubberStampAnnotationIcon Public Enum to define icon type of rubber stamp annotation.
PdfSubSuperScript Public enum to define the subscript or superscript mode.
PdfTemplateHorizontalAlignment Public enum to define horizontal alignment options.
PdfTemplateLayerMode Public enum to define template layer rendering mode.
PdfTemplateVerticalAlignment Public enum to define vertical alignment options.
PdfTextAlignment Public Enum to define text alignment of text box field.
PdfTextDirection Public enum to define the text direction.
PdfTextMarkupAnnotationType Public Enum to define type of text markup annotation.
PdfTextStyle Public enum to define text style.
PdfUnorderedListStyle Public enum to define the style used for unordered list.
PdfXmpSchemaType Enum for supported XMP-Schema types.
_PdfAnnotationType Enum for PDF loaded annotation type.
PdfCjkFontFamily Public enum to define CJK font family.
PdfFontFamily Public enum to define font family.
PdfFontStyle Public enum to define font style.
PdfVerticalAlignment Public enum to define vertical alignment.
Static Functions Root static functions of Pdf Component
ExternalSignatureCallback A callback function used for external signing of a PDF document with extended options.
If public certificates are provided before signing, data will be a 256-byte hash
that should be signed using the certificate’s private key.
If no public certificates are provided, data will be the full PDF content,
and the function should compute the hash using the given algorithm and standard.
TimestampCallback A callback function used to obtain the timestamp from a trusted timestamp authority (TSA) server.