ComPDFKit Web SDK
    Preparing search index...

    Namespace UI

    The UI namespace, available as instance.UI: loads documents and controls the viewer's interface (elements, panels, headers, tools, popups, notes, search, printing and more). Members are grouped by topic; component classes for building custom headers are in UI.Components.

    ClickedItemTypes
    ElementTagTarget
    Events
    Feature
    FeatureFlags
    FitMode
    JustifyContent
    Languages
    LayoutMode
    NotesPanelSortStrategy
    Panels
    PRESET_BUTTON_TYPES
    RedactionSearchPatterns
    Shortcuts
    Theme
    ToolbarGroup
    checkPermissionPassword
    closeDocument
    dispose
    downloadPdf
    getCustomData
    getPassword
    loadDocument
    saveAnnotations
    addEventListener
    removeEventListener
    closeElements
    closeTooltip
    disableElement
    disableElements
    enableAllElements
    enableElement
    enableElements
    isElementDisabled
    isElementOpen
    openElement
    openElements
    setClickMiddleware
    setElementTag
    setSelectedTab
    toggleElementVisibility
    updateElement
    disableFeatureFlag
    disableFeatures
    enableFeatureFlag
    enableFeatures
    clearPageFocus
    getActiveDocumentViewerKey
    getDocumentViewer
    getFitMode
    getLayoutMode
    getMaxZoomLevel
    getMinZoomLevel
    getScrollMode
    getZoomLevel
    getZoomStepFactors
    isFullscreen
    setActiveDocumentViewerKey
    setColorSeparationProfile
    setCustomStyle
    setFitMode
    setLayoutMode
    setMaxZoomLevel
    setMinZoomLevel
    setPageFocusEnabled
    setScrollMode
    setStickyNoteHoverEnabled
    setZoomLevel
    setZoomList
    setZoomStepFactors
    toggleFullScreen
    addToViewOnlyWhitelist
    disableViewOnlyMode
    enableViewOnlyMode
    getViewOnlyShortcuts
    getViewOnlyWhitelist
    removeFromViewOnlyWhitelist
    updateViewOnlyShortcuts
    updateViewOnlyWhitelist
    addLanguage
    getAvailableLanguages
    getCurrentLanguage
    getLocalizedText
    i18n
    removeLanguage
    setLanguage
    setLanguages
    setTheme
    setTranslations
    disableTool
    disableTools
    enableTool
    enableTools
    getActiveRibbonItem
    getToolMode
    isToolDisabled
    registerTool
    setActiveGroupedItems
    setActiveRibbonItem
    setAuthor
    setToolbarGroup
    setToolMode
    unregisterTool
    updateTool
    disableAnnotationToolStyleSyncing
    disableToolDefaultStyleUpdateFromAnnotationPopup
    enableAnnotationToolStyleSyncing
    enableToolDefaultStyleUpdateFromAnnotationPopup
    registerCustomFillStyle
    setActivePalette
    setColorPalette
    setIconColor
    unregisterCustomFillStyle
    addPanel
    getPanels
    setActiveLeftPanel
    setActiveTabInPanel
    setCustomPanel
    setPanels
    setPanelWidth
    setSideWindowVisibility
    addModularHeaders
    Components
    exportModularComponents
    Flyouts
    getGroupedItems
    getModularHeader
    getModularHeaderList
    getRibbonGroup
    importModularComponents
    setGroupedItemsGap
    setGroupedItemsGrow
    setGroupedItemsJustifyContent
    setModularHeaders
    annotationPopup
    contentEditPopup
    contextMenuPopup
    settingsMenuOverlay
    snippingToolPopup
    textPopup
    addCustomModal
    displayErrorMessage
    setCustomLoading
    showWarningMessage
    addSearchListener
    disableClearSearchOnPanelClose
    enableClearSearchOnPanelClose
    getSearchQuery
    overrideSearchExecution
    removeSearchListener
    searchText
    searchTextFull
    setActiveResult
    setSearchQuery
    setSearchResults
    cancelPrint
    print
    printInBackground
    setDefaultPrintOptions
    setGrayscaleDarknessFactor
    setPrintedNoteDateFormat
    setPrintQuality
    useEmbeddedPrint
    willUseEmbeddedPrinting
    addDateTimeFormat
    addSortStrategy
    dangerouslySetNoteTransformFunction
    disableAutosave
    disableNoteSubmissionWithEnter
    disableReplyForAnnotations
    enableAutosave
    enableNoteSubmissionWithEnter
    focusNote
    getAnnotationReadState
    NotesPanel
    setAnnotationContentOverlayHandler
    setAnnotationReadState
    setAutosaveInterval
    setCustomNoteFilter
    setCustomNoteSelectionFunction
    setInlineCommentFilter
    setNoteDateFormat
    setNotesPanelSort
    setNotesPanelSortStrategy
    setTimezone
    disableBookmarkIconShortcutVisibility
    enableBookmarkIconShortcutVisibility
    exportBookmarks
    importBookmarks
    OutlinesPanel
    reloadOutline
    setCustomOutlineJumpHandler
    disableApplyCropWarningModal
    disableApplySnippingWarningModal
    disablePageDeletionConfirmationModal
    enableApplyCropWarningModal
    enableApplySnippingWarningModal
    enablePageDeletionConfirmationModal
    extractPagesWithAnnotations
    multiPageManipulationControls
    pageManipulationOverlay
    setPageLabels
    setPageReplacementModalFileList
    setPresetCropDimensions
    setPresetNewPageDimensions
    setThumbnailSelectionMode
    thumbnailControlMenu
    ThumbnailsPanel
    disablePageEditorSave
    disablePageEditorSaveAs
    enablePageEditorSave
    enablePageEditorSaveAs
    enterPageEditorMode
    exitPageEditorMode
    isInPageEditorMode
    savePageEditor
    addRedactionSearchPattern
    removeRedactionSearchPattern
    replaceRedactionSearchPattern
    setCustomApplyRedactionsHandler
    addMeasurementScalePreset
    disableMultipleScalesMode
    enableMultipleScalesMode
    getMeasurementScalePreset
    isMultipleScalesModeEnabled
    removeMeasurementScalePreset
    setCustomMeasurementOverlayInfo
    setMeasurementUnits
    setScaleOverlayPosition
    Fonts
    getFontPath
    setFontPath
    addCustomStamps
    getCustomStamps
    setCustomStamps
    setImportStamps
    setStampPanelTabs
    disableSignatureDisclaimer
    enableSignatureDisclaimer
    getTextSignatureQuality
    setDisplayedSignaturesFilter
    setMaxSignaturesCount
    setSignatureDialogProperties
    setSignatureDialogTabs
    setSignatureFonts
    setSignatureModalColors
    setTextSignatureQuality
    signSignatureWidget
    VerificationOptions
    FormFill
    hideFormFieldIndicators
    setFormFillNavigatorCollapsed
    setFormFillNavigatorPosition
    showFormFieldIndicators
    disableMultiViewerSync
    enableMultiViewerSync
    enterMultiViewerMode
    exitMultiViewerMode
    isMultiViewerSyncing
    loadCompareDocument
    setCustomMultiViewerAcceptedFileFormats
    setCustomMultiViewerSyncHandler
    setMultiViewerSyncScrollingMode
    startTextComparison
    stopTextComparison
    hotkeys
    disableDesktopOnlyMode
    disableFadePageNavigationComponent
    disableNativeScrolling
    enableDesktopOnlyMode
    enableFadePageNavigationComponent
    enableNativeScrolling
    isInDesktopOnlyMode
    setSwipeOrientation
    exportUserSettings
    importUserSettings
    setCustomSettings