Welcome to Python API documentation!
Apryse SDK is the ultimate PDF toolkit.
With PDFTron components you can build reliable & speedy applications that can view, create, print, edit, and annotate PDFs … across operating systems.
Developers use Apryse SDK to read, write, and edit PDF documents compatible with all published versions of PDF specification (including the latest ISO32000). The extensive PDF library API supports most common use-case scenarios such as: * PDF Viewing & Collaboration
PDF Rasterization
PDF Printing
PDF Form filling and flattening
PDF Split & Merge
PDF Stamping
Dynamic PDF generation (e.g. FlowDocument & Xaml to PDF)
PDF Text extraction and indexing
PDF Packages
PDF Layers (OCGs)
PDF Editing
PDF Encryption
Manipulate PDF bookmarks, links, and annotations.
PDF Optimization
PDF conversion to XML, HTML, XPS, SVG, TIF, etc.
PDF/A Validation and Conversion
PDF Redaction
PDF Conversion from XPS, MS Office, HTML, XAML, TXT, TIFF etc.
HTML to PDF Conversion
Index
Table of contents
- Apryse SDK
ASCII85EncodeActionAction_CreateGoto()Action_CreateGotoRemote()Action_CreateHideField()Action_CreateImportData()Action_CreateInternal()Action_CreateJavaScript()Action_CreateLaunch()Action_CreateResetForm()Action_CreateSubmitForm()Action_CreateURI()AdvancedImagingModuleAdvancedImagingModule_IsModuleAvailable()AlgorithmIdentifierAlgorithmParamsAnnotAnnot_Create()Annot_CreateInternal()AppearanceAttrObjBitmapInfoBookmarkBookmark_Create()Bookmark_CreateInternal()BorderStyleCADConvertOptionsCADModuleCADModule_IsModuleAvailable()CMSSignatureOptionsCallbackCallback_StaticAnnotBitmapProc()Callback_StaticConnectionErrorProc()Callback_StaticCreateTileProc()Callback_StaticCurrentPageProc()Callback_StaticCurrentZoomProc()Callback_StaticDeluxeCreateTileProc()Callback_StaticErrorReportProc()Callback_StaticFindTextHandler()Callback_StaticJavaScriptEventProc()Callback_StaticPartDownloadedProc()Callback_StaticRemoveTileProc()Callback_StaticRenderBeginEventProc()Callback_StaticRenderFinishEventProc()Callback_StaticRequestRenderInWorkerThread()Callback_StaticThumbAsyncHandler()CaretCaret_Create()Caret_CreateAnnot()CharIteratorCharRangeCheckBoxWidgetCheckBoxWidget_Create()CircleCircle_Create()Circle_CreateAnnot()ClassMapColorPtColorSpaceColorSpace_CreateDeviceCMYK()ColorSpace_CreateDeviceGray()ColorSpace_CreateDeviceRGB()ColorSpace_CreateICC()ColorSpace_CreatePattern()ComboBoxWidgetComboBoxWidget_Create()ConfigConfig_Create()ContentElementContentItemContentNodeContentNodeIteratorContentReplacerContextContext_CreateInternal()ConversionMonitorConversionOptionsConvertConvert_CreateOfficeTemplate()Convert_CreateReflow()Convert_FromCAD()Convert_FromDICOM()Convert_FromEmf()Convert_FromSVG()Convert_FromText()Convert_FromTiff()Convert_FromXps()Convert_OfficeToPDF()Convert_PageToHtml()Convert_PageToHtmlZoned()Convert_RequiresPrinter()Convert_StreamingPDFConversion()Convert_ToEmf()Convert_ToEpub()Convert_ToExcel()Convert_ToHtml()Convert_ToPdf()Convert_ToPowerPoint()Convert_ToSvg()Convert_ToTiff()Convert_ToWord()Convert_ToXod()Convert_ToXodWithMonitor()Convert_ToXps()Convert_WordToPDF()Convert_WordToPDFConversion()DataExtractionModuleDataExtractionModule_DetectAndAddFormFieldsToPDF()DataExtractionModule_ExtractData()DataExtractionModule_ExtractToXLSX()DataExtractionModule_IsModuleAvailable()DataExtractionOptionsDateDestinationDestination_CreateFit()Destination_CreateFitB()Destination_CreateFitBH()Destination_CreateFitBV()Destination_CreateFitH()Destination_CreateFitR()Destination_CreateFitV()Destination_CreateXYZ()DictIteratorDiffOptionsDigestAlgorithmDigestAlgorithm_CalculateDigest()DigestAlgorithm_SignDigest()DigitalSignatureFieldDigitalSignatureFieldIteratorDigitalSignatureField_GenerateCMSSignature()DigitalSignatureField_GenerateCMSSignedAttributes()DigitalSignatureField_GenerateESSSigningCertPAdESAttribute()DigitalSignatureField_SetDigSigLogFilename()DigitalSignatureField_SignDigest()DisallowedChangeDocSnapshotDocumentConversionDocumentConversion_CreateInternal()EPUBOutputOptionsElementElementBuilderElementReaderElementWriterEmbeddedTimestampVerificationResultExcelOutputOptionsFDFDocFDFDoc_CreateFromXFDF()FDFFieldFDFFieldIteratorFieldFieldIteratorFileAttachmentFileAttachment_Create()FileAttachment_CreateAnnot()FileSpecFileSpec_Create()FileSpec_CreateURL()FilterFilterReaderFilterWriterFlateEncodeFlattenerFlowDocumentFontFont_Create()Font_CreateCIDTrueTypeFont()Font_CreateTrueTypeFont()Font_CreateType1Font()FreeTextFreeText_Create()FreeText_CreateAnnot()FunctionGSChangesIteratorGStateGState_GetRenderingIntentType()GroupGroup_Create()HTML2PDFHTML2PDF_IsModuleAvailable()HTML2PDF_SetModulePath()HTMLOutputOptionsHighlightHighlightAnnotHighlightAnnot_Create()HighlightAnnot_CreateAnnot()HighlightsHighlights_CreateInternal()ImageImage2RGBImage2RGBAImageSettingsImage_Create()Image_CreateImageMask()Image_CreateSoftMask()InkInk_Create()Ink_CreateAnnot()LineLineAnnotLineAnnot_Create()LineAnnot_CreateAnnot()LinkLink_Create()Link_CreateAnnot()Link_GetNormalizedUrl()ListListBoxWidgetListBoxWidget_Create()ListItemMappedFileMappedFile_Equivalent()MarkupMatrix2DMatrix2D_IdentityMatrix()Matrix2D_RotationMatrix()Matrix2D_ZeroMatrix()MemoryFilterMonoImageSettingsMovieMovie_Create()Movie_CreateAnnot()NameTreeNameTree_Create()NameTree_Find()NumberTreeOCMDOCMD_Create()OCRModuleOCRModule_ApplyOCRJsonToPDF()OCRModule_ApplyOCRXmlToPDF()OCRModule_GetOCRJsonFromImage()OCRModule_GetOCRJsonFromPDF()OCRModule_GetOCRXmlFromImage()OCRModule_GetOCRXmlFromPDF()OCRModule_ImageToPDF()OCRModule_IsIRISModuleAvailable()OCRModule_IsModuleAvailable()OCRModule_ProcessPDF()OCROptionsObjObjSetObj_CreateInternal()ObjectIdentifierOfficeToPDFOptionsOptimizerOptimizerSettingsOptimizer_Optimize()OutputOptionsOCROutputOptionsOCR_LanguageChoiceToString()OutputOptionsOCR_PreferredOCRChoiceToString()PDF2HtmlReflowParagraphsModulePDF2HtmlReflowParagraphsModule_IsModuleAvailable()PDF2WordModulePDF2WordModule_IsModuleAvailable()PDFACompliancePDFACompliance_GetDeclaredConformance()PDFACompliance_GetPDFAErrorMessage()PDFAOptionsPDFDocPDFDocInfoPDFDocViewPrefsPDFDoc_CreateInternal()PDFDoc_HighlightTextDiff()PDFDrawPDFNetPDFNet_AddFontSubst()PDFNet_AddPDFTronCustomHandler()PDFNet_AddResourceSearchPath()PDFNet_EnableJavaScript()PDFNet_GetResourcesPath()PDFNet_GetSystemFontList()PDFNet_GetVersion()PDFNet_GetVersionString()PDFNet_Initialize()PDFNet_IsJavaScriptEnabled()PDFNet_SetColorManagement()PDFNet_SetConnectionErrorHandlingMode()PDFNet_SetConnectionErrorProc()PDFNet_SetDefaultDeviceCMYKProfile()PDFNet_SetDefaultDeviceRGBProfile()PDFNet_SetDefaultDiskCachingEnabled()PDFNet_SetDefaultFlateCompressionLevel()PDFNet_SetLogLevel()PDFNet_SetPersistentCachePath()PDFNet_SetResourcesPath()PDFNet_SetTempPath()PDFNet_SetViewerCache()PDFNet_SetWriteAPIUsageLocally()PDFNet_Terminate()PDFRasterizerPDFTronCustomSecurityHandlerPDFViewPDFView_SetViewerCache()PagePageIteratorPageLabelPageLabel_Create()PageSetPage_AddRotations()Page_DegreeToRotation()Page_RotationToDegree()Page_SubtractRotations()ParagraphPathDataPatternColorPointPolyLinePolyLine_Create()PolyLine_CreateAnnot()PolygonPolygon_Create()Polygon_CreateAnnot()PopupPopup_Create()Popup_CreateAnnot()PowerPointOutputOptionsPrintPrintToPdfModulePrintToPdfModule_IsModuleAvailable()PrintToPdfModule_PrintToPdf()PrintToPdfOptionsPrint_StartPrintJob()PrinterPrinterModePrinter_GetMode()Printer_GetPrinterName()Printer_Install()Printer_IsInstalled()Printer_SetMode()Printer_SetPrinterName()Printer_Uninstall()ProxyPushButtonWidgetPushButtonWidget_Create()QuadPointRSASSAPSSParamsRadioButtonGroupRadioButtonGroup_Create()RadioButtonWidgetRectRectCollectionRedactionRedactionAnnotRedactionAnnot_Create()RedactionAnnot_CreateAnnot()RedactorRedactor_Redact()RefreshOptionsResultSnapshotRoleMapRubberStampRubberStamp_Create()RubberStamp_CreateAnnot()SDFDocSDFDoc_CreateInternal()SElementSElement_Create()STreeSTree_Create()SVGConvertOptionsSVGOutputOptionsScreenScreen_Create()Screen_CreateAnnot()SearchResultSecurityHandlerSelectionSeparationShadingShapedTextSignatureHandlerSignatureWidgetSignatureWidget_Create()SoundSound_Create()Sound_CreateAnnot()Sound_CreateWithData()SquareSquare_Create()Square_CreateAnnot()SquigglySquiggly_Create()Squiggly_CreateAnnot()StamperStamper_DeleteStamps()Stamper_HasStamps()StrikeOutStrikeOut_Create()StrikeOut_CreateAnnot()StructuredOutputModuleStructuredOutputModule_IsModuleAvailable()StyleSwigPyIteratorTOCSettingsTRN_byterangeTRN_chardataTRN_dateTRN_matrix2dTRN_pointTRN_quadpointTRN_rectTableTableCellTableRowTemplateDocumentTemplateDocument_CreateInternal()TextTextDiffOptionsTextExtractorTextMarkupTextRangeTextRange_CreateInternal()TextRunTextSearchTextSettingsTextStyledElementTextWidgetTextWidget_Create()Text_Create()Text_CreateAnnot()TiffOutputOptionsTimestampingConfigurationTimestampingResultTrustVerificationResultUInt32IteratorUnderlineUnderline_Create()Underline_CreateAnnot()UndoManagerVectorAnnotVectorByteRangeVectorCharVectorDisallowedChangeVectorDoubleVectorIntVectorObjVectorPageVectorQuadPointVectorRedactionVectorSeparationVectorStringVectorUCharVectorVectorX509CertificateVectorX501AttributeTypeAndValueVectorX509CertificateVectorX509ExtensionVerificationOptionsVerificationResultViewChangeCollectionViewChangeCollection_CreateInternal()ViewerOptimizedOptionsWatermarkWatermark_Create()Watermark_CreateAnnot()WebFontDownloaderWebFontDownloader_ClearCache()WebFontDownloader_DisableDownloads()WebFontDownloader_EnableDownloads()WebFontDownloader_IsAvailable()WebFontDownloader_PreCacheAsync()WebFontDownloader_SetCustomWebFontURL()WebPageSettingsWidgetWidget_Create()WordWordOutputOptionsWordToPDFOptionsX501AttributeTypeAndValueX501DistinguishedNameX509CertificateX509ExtensionXODOutputOptionsXPSOutputCommonOptionsXPSOutputOptionse_downloadedtype_failede_downloadedtype_finishede_downloadedtype_named_destse_downloadedtype_openede_downloadedtype_outlinee_downloadedtype_pagee_downloadedtype_thumb