PDF Web SDK Documentation

Comprehensive Guide for Developers: UI & SDK Integration, Configuration, and API Reference

PDF Web SDK
    Preparing search index...

    Module ui

    Enumerations

    ActiveSideBySideWindow
    ActivitySurface
    ActivityType
    AppearanceDataType
    AppearanceType
    CertifyTool
    CommentTool
    ContextMenu
    ContextMenuOperations
    CreateTool
    DocumentCommand
    DocumentViewModeEnum
    EDialogDocumentType
    EDialogWorkerType
    EditTool
    ESignTool
    FieldType
    FillAndSignTool
    FormTool
    HeaderTab
    LabelAlignment
    LayoutVariant
    PageTool
    PdfPageView
    SecureTool
    ToolArea
    ToolsDisplayMode
    ToolsHorizontalAlignment
    ToolsTool
    ToolTypes
    TranslateTool
    Units

    Classes

    BLScrollBarType

    Interfaces

    Annotation
    AnnotationBorder
    AppearanceModel
    CaretRange
    DialogContainerOptions
    DialogOverlayOptions
    ESignDocument
    ESignField
    ESignFieldOptions
    ESignFieldRenderData
    ESignMarkerContent
    ESignMarkerRenderData
    ESignRenderData
    ESignRole
    FillSignSignatureFieldCreateParams
    IActivityEvent
    IApiCallbackUrlsConfig
    IBrandingConfig
    IConfigChangeData
    IContextMenuRequestData
    IConvertToOfficeExecuteResult
    ICustomFilesProvider
    IDefaultFontConfig
    IDeviceConfig
    IDocumentOrigin
    IDocumentTab
    IDocumentTabsAPI
    IDocumentView
    IDocumentViewerWrapperElement
    IDocumentViewModel
    IDocumentViewService
    IDocumentViewState
    IDropboxConfig
    IExportFileModelOptions
    IFileItem
    IFilesProvider
    IGoogleDriveConfig
    IGridConfig
    IHeaderConfig
    ILanguage
    ILanguageConfig
    ILayoutConfig
    INetExplorerConfig
    IOcrAdvancedConfig
    IOcrExecuteResult
    IOneDriveConfig
    IOpenFormat
    IOpenFormatsConfig
    IPdfaConvertExecuteResult
    IPdfEditorResult
    IRecentEntry
    IRecentsConfig
    ISaveAsTarget
    ISessionTokens
    ISetupOptions
    ISnackbarHandle
    ITabConfig
    IThemeConfig
    ITranslateConfig
    ITranslateExecuteResult
    IUnitsAndGuidesConfig
    IUserInfo
    IUserManagementConfig
    PaletteInterface
    PDFColorModel
    Position
    SnackbarAction
    SnackbarOptions
    TDialogTemplateConfig
    UploadInputsData

    Type Aliases

    ActivityItemAction
    ActivityLeafValue
    ActivityToolId
    AllowSaveGuard
    ApiAuthMode
    CloudDownloadProgress
    CustomThemePallet
    DocumentsViewArray
    ESignDateFormat
    IActivityCallback
    IContextMenuRequestedCallback
    IESignFieldEditRequestedCallback
    IESignFieldFillRequestedCallback
    IESignSignRequestedCallback
    IPasswordRequiredCallback
    IPasswordRequiredError
    IRemoveSignatureRequestedCallback
    LanguageCode
    OcrCompressionQuality
    OcrRecognitionQuality
    OcrRecognizedTextOutput
    OcrScanPreference
    PaletteCustomProperty
    PaletteTokenName
    ShowSnackbarOptions
    SnackbarType
    TabsListConfig
    ThemeType
    ToolAreasConfig
    ToolsConfig

    Variables

    Tools

    Functions

    PdfEditor

    References

    CertificateDetail → CertificateDetail
    CertificateExtension → CertificateExtension
    CertificateFingerprint → CertificateFingerprint
    CharInfo → CharInfo
    CharsCollection → CharsCollection
    ContentElement → ContentElement
    DrawPageBox → DrawPageBox
    EFontStyle → EFontStyle
    ExportFileAs → ExportFileAs
    fileKeys → fileKeys
    fontAllVariants → fontAllVariants
    fontBoldItalicVariants → fontBoldItalicVariants
    fontBoldVariants → fontBoldVariants
    fontItalicVariants → fontItalicVariants
    fontRegularVariants → fontRegularVariants
    fontSubset → fontSubset
    IAcroformContent → IAcroformContent
    IAcroformOptionsItem → IAcroformOptionsItem
    IAddAttachmentData → IAddAttachmentData
    IAddBookmarkData → IAddBookmarkData
    IAddBookmarkDataRequestActions → IAddBookmarkDataRequestActions
    IApiOperationClient → IApiOperationClient
    IArtifact → IArtifact
    IAutoOrderAnnotationData → IAutoOrderAnnotationData
    IBookmarkRequestData → IBookmarkRequestData
    ICanChangeAnnotZOrderData → ICanChangeAnnotZOrderData
    ICanChangeAnnotZOrderResponse → ICanChangeAnnotZOrderResponse
    ICanChangeElementZOrderData → ICanChangeElementZOrderData
    ICanChangeElementZOrderResponse → ICanChangeElementZOrderResponse
    ICanChangeTextBlockZOrderResponse → ICanChangeTextBlockZOrderResponse
    IChangeAcroformValueData → IChangeAcroformValueData
    IChangeAnnotationPropertiesData → IChangeAnnotationPropertiesData
    IChangeAnnotationPropertiesDataProperties → IChangeAnnotationPropertiesDataProperties
    IChangeAnnotationPropertiesResponse → IChangeAnnotationPropertiesResponse
    IChangeAnnotOrderData → IChangeAnnotOrderData
    IChangeDocumentHistoryData → IChangeDocumentHistoryData
    IChangeDocumentPropertiesData → IChangeDocumentPropertiesData
    IChangeElementMatrixData → IChangeElementMatrixData
    IChangeElementOrderData → IChangeElementOrderData
    IChangeFontAttributesData → IChangeFontAttributesData
    IChangeLayerStateData → IChangeLayerStateData
    IChangeListStyleData → IChangeListStyleData
    IChangeMarginData → IChangeMarginData
    IChangePagesBoxesData → IChangePagesBoxesData
    IChangeParaAttrsData → IChangeParaAttrsData
    IChangePropertiesData → IChangePropertiesData
    IChangeSizeData → IChangeSizeData
    IChangeTextBlockZOrder → IChangeTextBlockZOrder
    IChangeTextBlockZOrderData → IChangeTextBlockZOrderData
    IClaimedData → IClaimedData
    IClipFactoryData → IClipFactoryData
    IContentObjectJson → IContentObjectJson
    IContentOptions → IContentOptions
    IConvertToOfficeClient → IConvertToOfficeClient
    IConvertToOfficeCommandData → IConvertToOfficeCommandData
    IConvertToOfficeCommandResult → IConvertToOfficeCommandResult
    ICopyContentElementData → ICopyContentElementData
    ICopyContentElementResponse → ICopyContentElementResponse
    ICopyTextBlockData → ICopyTextBlockData
    ICopyTextBlockResponse → ICopyTextBlockResponse
    ICreateAnnotationParams → ICreateAnnotationParams
    ICreateAnnotationUnifiedData → ICreateAnnotationUnifiedData
    ICreateAnnotationUnifiedParamsStyle → ICreateAnnotationUnifiedParamsStyle
    ICreateClipData → ICreateClipData
    ICreateMeasurementAnnotationDataMeasure → ICreateMeasurementAnnotationDataMeasure
    ICreateMeasurementAnnotationDataMeasureItem → ICreateMeasurementAnnotationDataMeasureItem
    ICreateMeasurementCalibrationData → ICreateMeasurementCalibrationData
    ICreateNewDocumentData → ICreateNewDocumentData
    ICreateStampAnnotationData → ICreateStampAnnotationData
    ICreateTextBlockData → ICreateTextBlockData
    ICreateWidgetAnnotationData → ICreateWidgetAnnotationData
    ICropImageData → ICropImageData
    IDeleteAnnotationData → IDeleteAnnotationData
    IDeleteAttachmentData → IDeleteAttachmentData
    IDeleteBookmarkData → IDeleteBookmarkData
    IDeleteClipData → IDeleteClipData
    IDeleteContentElementData → IDeleteContentElementData
    IDeleteHeaderData → IDeleteHeaderData
    IDeletePageNumberData → IDeletePageNumberData
    IDeletePagesData → IDeletePagesData
    IDeleteTextBlockData → IDeleteTextBlockData
    IDeleteWatermarkData → IDeleteWatermarkData
    IDeskewData → IDeskewData
    IDocInfo → IDocInfo
    IDocumentAnnotation → IDocumentAnnotation
    IDocumentCommandsBase → IDocumentCommandsBase
    IDocumentHistory → IDocumentHistory
    IDocumentInfoResponse → IDocumentInfoResponse
    IDocumentModel → IDocumentModel
    IDocumentSecurity → IDocumentSecurity
    IDoWhiteoutData → IDoWhiteoutData
    IDownloadSignedVersionData → IDownloadSignedVersionData
    IDrawPageData → IDrawPageData
    IDrawPageResponse → IDrawPageResponse
    IEditPageTextData → IEditPageTextData
    IEditTextParagraphs → IEditTextParagraphs
    IErrorLike → IErrorLike
    IExportAppearanceStampData → IExportAppearanceStampData
    IExportFileFromWorkerParams → IExportFileFromWorkerParams
    IExportFileResponse → IExportFileResponse
    IExportFillSignSignAsset → IExportFillSignSignAsset
    IExtractData → IExtractData
    IExtractImageData → IExtractImageData
    IExtractImagesData → IExtractImagesData
    IFileDataFile → IFileDataFile
    IFillSignCreateData → IFillSignCreateData
    IFillSignDeleteData → IFillSignDeleteData
    IFillSignField → IFillSignField
    IFillSignPatchData → IFillSignPatchData
    IFlags → IFlags
    IFlattenAnnotData → IFlattenAnnotData
    IFont → IFont
    IFontAttributes → IFontAttributes
    IFontMini → IFontMini
    IForgetContentElementData → IForgetContentElementData
    IFormField → IFormField
    IGetContentResponse → IGetContentResponse
    IGetMeasurementViewportsData → IGetMeasurementViewportsData
    IGetMeasurementViewportsResponse → IGetMeasurementViewportsResponse
    IGetTextAsTableData → IGetTextAsTableData
    IHasRecognizableImagesData → IHasRecognizableImagesData
    IIcon → IIcon
    IImportAcroformsFdfDataData → IImportAcroformsFdfDataData
    IInitializeData → IInitializeData
    IInsertBatesNumberingData → IInsertBatesNumberingData
    IInsertBlankPagesData → IInsertBlankPagesData
    IInsertCharData → IInsertCharData
    IInsertDuplicatePagesData → IInsertDuplicatePagesData
    IInsertHeaderData → IInsertHeaderData
    IInsertImageData → IInsertImageData
    IInsertPageNumberData → IInsertPageNumberData
    IInsertPagesFromFileData → IInsertPagesFromFileData
    IInsertWatermarkData → IInsertWatermarkData
    IListAttrs → IListAttrs
    IListContentResponse → IListContentResponse
    IListLevelStyle → IListLevelStyle
    IMeasure → IMeasure
    IMergeTextBlocksData → IMergeTextBlocksData
    IMoveBookmarkData → IMoveBookmarkData
    IMovePagesData → IMovePagesData
    INewDocumentOptions → INewDocumentOptions
    INumberFormat → INumberFormat
    IOcrClient → IOcrClient
    IOcrCommandData → IOcrCommandData
    IOcrCommandResult → IOcrCommandResult
    IOpenDocumentOptions → IOpenDocumentOptions
    IOpenFileAnnotation → IOpenFileAnnotation
    IOpenFileResponseFonts → IOpenFileResponseFonts
    IOpenFileResponseP → IOpenFileResponseP
    IOperationData → IOperationData
    IOperationRequestedCallback → IOperationRequestedCallback
    IOrderAnnotationData → IOrderAnnotationData
    IPagedApiCommandData → IPagedApiCommandData
    IPagedApiCommandResult → IPagedApiCommandResult
    IPageModel → IPageModel
    IPageModelOptions → IPageModelOptions
    IParagraphListAttrs → IParagraphListAttrs
    IPasteContentElementData → IPasteContentElementData
    IPasteTextBlockData → IPasteTextBlockData
    IPdfaConvertClient → IPdfaConvertClient
    IPdfaConvertCommandData → IPdfaConvertCommandData
    IPdfaConvertCommandResult → IPdfaConvertCommandResult
    IPdfAcroformOptions → IPdfAcroformOptions
    IPDFAction → IPDFAction
    IPdfActionClone → IPdfActionClone
    IPdfActionData → IPdfActionData
    IPDFAnnotationContent → IPDFAnnotationContent
    IPdfClipGeometry → IPdfClipGeometry
    IPDFLinkBorder → IPDFLinkBorder
    IPdfSdk → IPdfSdk
    IProperties → IProperties
    IReplaceTextData → IReplaceTextData
    IReplaceWithBlankPagesData → IReplaceWithBlankPagesData
    IReplaceWithDuplicatePagesData → IReplaceWithDuplicatePagesData
    IReplaceWithPagesFromFileData → IReplaceWithPagesFromFileData
    IReversePages → IReversePages
    IrisOcrPdfType → IrisOcrPdfType
    IRotatePagesData → IRotatePagesData
    ISaveAttachmentData → ISaveAttachmentData
    ISecuritySaveSettingsData → ISecuritySaveSettingsData
    ISetBackgroundData → ISetBackgroundData
    ISignPdfCertificate → ISignPdfCertificate
    ISignPdfClient → ISignPdfClient
    ISignPdfCommandData → ISignPdfCommandData
    ISignPdfCommandResult → ISignPdfCommandResult
    ISignPdfSignaturePosition → ISignPdfSignaturePosition
    ISignPdfSignatureUpload → ISignPdfSignatureUpload
    ISpan → ISpan
    IStampAppearanceData → IStampAppearanceData
    IStampIcon → IStampIcon
    ITempBookmarkData → ITempBookmarkData
    ITextAsTableResponse → ITextAsTableResponse
    ITextBlock → ITextBlock
    ITextBlocksDataResponse → ITextBlocksDataResponse
    ITextLine → ITextLine
    ITextParagraph → ITextParagraph
    ITextParagraphAttributes → ITextParagraphAttributes
    ITransformClipData → ITransformClipData
    ITransformTextBlockData → ITransformTextBlockData
    ITranslateClient → ITranslateClient
    ITranslateCommandData → ITranslateCommandData
    ITranslateCommandResult → ITranslateCommandResult
    ITranslateOperationData → ITranslateOperationData
    IUndoChanged → IUndoChanged
    IUndoChangedPages → IUndoChangedPages
    IUndoResponse → IUndoResponse
    IUserFont → IUserFont
    IUserFontData → IUserFontData
    MatrixModel → MatrixModel
    PageLayout → PageLayout
    PageMode → PageMode
    ParsedCertificate → ParsedCertificate
    PdfEditorErrorParams → PdfEditorErrorParams
    PdfEditorPasswordErrorParams → PdfEditorPasswordErrorParams
    PDOptSaveImageQuality → PDOptSaveImageQuality
    PDPageDirection → PDPageDirection
    PointModel → PointModel
    ProcessingStep → ProcessingStep
    PropertiesSignimage → PropertiesSignimage
    QuadModel → QuadModel
    RectModel → RectModel
    resolveWorkerPath → resolveWorkerPath
    SizeModel → SizeModel
    TextBlockData → TextBlockData
    TextStyle → TextStyle
    TGeometryPoint → TGeometryPoint
    WorkerOperation → WorkerOperation

    Settings

    Member Visibility

    On This Page

    Enumerations
    Classes
    Interfaces
    AnnotationAnnotationBorderAppearanceModelCaretRangeDialogContainerOptionsDialogOverlayOptionsESignDocumentESignFieldESignFieldOptionsESignFieldRenderDataESignMarkerContentESignMarkerRenderDataESignRenderDataESignRoleFillSignSignatureFieldCreateParamsIActivityEventIApiCallbackUrlsConfigIBrandingConfigIBrandingLinkIConfigChangeDataIContextMenuRequestDataIConvertToOfficeExecuteResultICustomFilesProviderIDefaultFontConfigIDeviceConfigIDocumentOriginIDocumentTabIDocumentTabsAPIIDocumentViewIDocumentViewerWrapperElementIDocumentViewModelIDocumentViewServiceIDocumentViewStateIDropboxConfigIExportFileModelOptionsIFileItemIFilesProviderIGoogleDriveConfigIGridConfigIHeaderConfigILanguageILanguageConfigILayoutConfigINetExplorerConfigIOcrAdvancedConfigIOcrExecuteResultIOneDriveConfigIOpenFormatIOpenFormatsConfigIPdfaConvertExecuteResultIPdfEditorResultIRecentEntryIRecentsConfigISaveAsTargetISessionTokensISetupOptionsISnackbarHandleITabConfigIThemeConfigITranslateConfigITranslateExecuteResultIUnitsAndGuidesConfigIUserInfoIUserManagementConfigPaletteInterfacePDFColorModelPositionSnackbarActionSnackbarOptionsTDialogTemplateConfigUploadInputsData
    Type Aliases
    Variables
    Functions
    References
    CertificateDetailCertificateExtensionCertificateFingerprintCharInfoCharsCollectionContentElementDrawPageBoxEFontStyleExportFileAsfileKeysfontAllVariantsfontBoldItalicVariantsfontBoldVariantsfontItalicVariantsfontRegularVariantsfontSubsetIAcroformContentIAcroformOptionsItemIAddAttachmentDataIAddBookmarkDataIAddBookmarkDataRequestActionsIApiOperationClientIArtifactIAutoOrderAnnotationDataIBookmarkRequestDataICanChangeAnnotZOrderDataICanChangeAnnotZOrderResponseICanChangeElementZOrderDataICanChangeElementZOrderResponseICanChangeTextBlockZOrderResponseIChangeAcroformValueDataIChangeAnnotationPropertiesDataIChangeAnnotationPropertiesDataPropertiesIChangeAnnotationPropertiesResponseIChangeAnnotOrderDataIChangeDocumentHistoryDataIChangeDocumentPropertiesDataIChangeElementMatrixDataIChangeElementOrderDataIChangeFontAttributesDataIChangeLayerStateDataIChangeListStyleDataIChangeMarginDataIChangePagesBoxesDataIChangeParaAttrsDataIChangePropertiesDataIChangeSizeDataIChangeTextBlockZOrderIChangeTextBlockZOrderDataIClaimedDataIClipFactoryDataIContentObjectJsonIContentOptionsIConvertToOfficeClientIConvertToOfficeCommandDataIConvertToOfficeCommandResultICopyContentElementDataICopyContentElementResponseICopyTextBlockDataICopyTextBlockResponseICreateAnnotationParamsICreateAnnotationUnifiedDataICreateAnnotationUnifiedParamsStyleICreateClipDataICreateMeasurementAnnotationDataMeasureICreateMeasurementAnnotationDataMeasureItemICreateMeasurementCalibrationDataICreateNewDocumentDataICreateStampAnnotationDataICreateTextBlockDataICreateWidgetAnnotationDataICropImageDataIDeleteAnnotationDataIDeleteAttachmentDataIDeleteBookmarkDataIDeleteClipDataIDeleteContentElementDataIDeleteHeaderDataIDeletePageNumberDataIDeletePagesDataIDeleteTextBlockDataIDeleteWatermarkDataIDeskewDataIDocInfoIDocumentAnnotationIDocumentCommandsBaseIDocumentHistoryIDocumentInfoResponseIDocumentModelIDocumentSecurityIDoWhiteoutDataIDownloadSignedVersionDataIDrawPageDataIDrawPageResponseIEditPageTextDataIEditTextParagraphsIErrorLikeIExportAppearanceStampDataIExportFileFromWorkerParamsIExportFileResponseIExportFillSignSignAssetIExtractDataIExtractImageDataIExtractImagesDataIFileDataFileIFillSignCreateDataIFillSignDeleteDataIFillSignFieldIFillSignPatchDataIFlagsIFlattenAnnotDataIFontIFontAttributesIFontMiniIForgetContentElementDataIFormFieldIGetContentResponseIGetMeasurementViewportsDataIGetMeasurementViewportsResponseIGetTextAsTableDataIHasRecognizableImagesDataIIconIImportAcroformsFdfDataDataIInitializeDataIInsertBatesNumberingDataIInsertBlankPagesDataIInsertCharDataIInsertDuplicatePagesDataIInsertHeaderDataIInsertImageDataIInsertPageNumberDataIInsertPagesFromFileDataIInsertWatermarkDataIListAttrsIListContentResponseIListLevelStyleIMeasureIMergeTextBlocksDataIMoveBookmarkDataIMovePagesDataINewDocumentOptionsINumberFormatIOcrClientIOcrCommandDataIOcrCommandResultIOpenDocumentOptionsIOpenFileAnnotationIOpenFileResponseFontsIOpenFileResponsePIOperationDataIOperationRequestedCallbackIOrderAnnotationDataIPagedApiCommandDataIPagedApiCommandResultIPageModelIPageModelOptionsIParagraphListAttrsIPasteContentElementDataIPasteTextBlockDataIPdfaConvertClientIPdfaConvertCommandDataIPdfaConvertCommandResultIPdfAcroformOptionsIPDFActionIPdfActionCloneIPdfActionDataIPDFAnnotationContentIPdfClipGeometryIPDFLinkBorderIPdfSdkIPropertiesIReplaceTextDataIReplaceWithBlankPagesDataIReplaceWithDuplicatePagesDataIReplaceWithPagesFromFileDataIReversePagesIrisOcrPdfTypeIRotatePagesDataISaveAttachmentDataISecuritySaveSettingsDataISetBackgroundDataISignPdfCertificateISignPdfClientISignPdfCommandDataISignPdfCommandResultISignPdfSignaturePositionISignPdfSignatureUploadISpanIStampAppearanceDataIStampIconITempBookmarkDataITextAsTableResponseITextBlockITextBlocksDataResponseITextLineITextParagraphITextParagraphAttributesITransformClipDataITransformTextBlockDataITranslateClientITranslateCommandDataITranslateCommandResultITranslateOperationDataIUndoChangedIUndoChangedPagesIUndoResponseIUserFontIUserFontDataMatrixModelPageLayoutPageModeParsedCertificatePdfEditorErrorParamsPdfEditorPasswordErrorParamsPDOptSaveImageQualityPDPageDirectionPointModelProcessingStepPropertiesSignimageQuadModelRectModelresolveWorkerPathSizeModelTextBlockDataTextStyleTGeometryPointWorkerOperation