PDF Web SDK Documentation

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

PDF Web SDK
    Preparing search index...

    Interface IDocumentCommandsBase

    interface IDocumentCommandsBase {
        addAttachment(data: IAddAttachmentData): Promise<IUndoResponse>;
        addBookmark(data: IAddBookmarkData): Promise<IUndoResponse>;
        applyRedactions(): Promise<IUndoResponse>;
        autoOrderAnnotation(data: IAutoOrderAnnotationData): Promise<IUndoResponse>;
        bookmarkAddAfter(
            pageIndex: number,
            parentIndex: number[],
            title?: string,
        ): Promise<IUndoResponse>;
        bookmarkAddBefore(
            pageIndex: number,
            parentIndex: number[],
            title?: string,
        ): Promise<IUndoResponse>;
        bookmarkAddChild(
            pageIndex: number,
            parentIndex: number[],
            title?: string,
        ): Promise<IUndoResponse>;
        changeAcroformValue(data: IChangeAcroformValueData): Promise<IUndoResponse>;
        changeAnnotationProperties(
            data: IChangeAnnotationPropertiesData,
            type: AnnotsTypes,
        ): Promise<IChangeAnnotationPropertiesResponse>;
        changeAnnotOrder(data: IChangeAnnotOrderData): Promise<IUndoResponse>;
        changeDocumentHistory(
            data: IChangeDocumentHistoryData,
        ): Promise<IUndoResponse>;
        changeDocumentProperties(
            data: IChangeDocumentPropertiesData,
        ): Promise<IUndoResponse>;
        changeElementMatrix(data: IChangeElementMatrixData): Promise<IUndoResponse>;
        changeElementOrder(data: IChangeElementOrderData): Promise<IUndoResponse>;
        changeFontAttributes(
            data: IChangeFontAttributesData,
        ): Promise<IUndoResponse>;
        changeListStyle(data: IChangeListStyleData): Promise<IUndoResponse>;
        changePagesBackground(data: ISetBackgroundData): Promise<IUndoResponse>;
        changePagesBoxes(data: IChangePagesBoxesData): Promise<IUndoResponse>;
        changePagesMargin(data: IChangeMarginData): Promise<IUndoResponse>;
        changeParaAttrs(data: IChangeParaAttrsData): Promise<IUndoResponse>;
        changeTextBlockZOrder(
            data: IChangeTextBlockZOrderData,
        ): Promise<IUndoResponse>;
        clearAllSignatures(): Promise<IUndoResponse>;
        clearDocumentHistory(): Promise<IUndoResponse>;
        convertToOffice(
            data: IConvertToOfficeCommandData,
        ): Promise<IConvertToOfficeCommandResult>;
        convertToPdfA(
            data: IPdfaConvertCommandData,
        ): Promise<IPdfaConvertCommandResult>;
        createAnnotation(
            data: ICreateAnnotationUnifiedData,
        ): Promise<IUndoResponse>;
        createClip(data: ICreateClipData): Promise<IUndoResponse>;
        createMeasurementCalibration(
            data: ICreateMeasurementCalibrationData,
        ): Promise<IUndoResponse>;
        createTextBlock(data: ICreateTextBlockData): Promise<IUndoResponse>;
        createWidgetAnnotation(
            data: ICreateWidgetAnnotationData,
        ): Promise<IUndoResponse>;
        cropImage(data: ICropImageData): Promise<IUndoResponse>;
        deleteAllBookmarks(): Promise<IUndoResponse>;
        deleteAnnotations(data: IDeleteAnnotationData$1): Promise<IUndoResponse>;
        deleteAttachment(data: IDeleteAttachmentData): Promise<IUndoResponse>;
        deleteBatesNumbering(): Promise<IUndoResponse>;
        deleteBookmark(data: IDeleteBookmarkData): Promise<IUndoResponse>;
        deleteClip(data: IDeleteClipData): Promise<IUndoResponse>;
        deleteContentElements(
            data: IDeleteContentElementData,
        ): Promise<IUndoResponse>;
        deleteHeader(data: IDeleteHeaderData): Promise<IUndoResponse>;
        deletePageNumber(data: IDeletePageNumberData): Promise<IUndoResponse>;
        deletePages(data: IDeletePagesData): Promise<IUndoResponse>;
        deleteTextBlocks(data: IDeleteTextBlockData): Promise<IUndoResponse>;
        deleteWatermark(data: IDeleteWatermarkData): Promise<IUndoResponse>;
        editPageText(data: IEditPageTextData): Promise<IUndoResponse>;
        editTextParagraphs(data: IEditTextParagraphs): Promise<IUndoResponse>;
        fillSignCreate(data: IFillSignCreateData): Promise<IUndoResponse>;
        fillSignDelete(data: IFillSignDeleteData): Promise<IUndoResponse>;
        fillSignUpdate(data: IFillSignPatchData): Promise<IUndoResponse>;
        flattenAnnotation(data: IFlattenAnnotData): Promise<IUndoResponse>;
        importAcroformsFdfData(data: File): Promise<IUndoResponse>;
        insertBatesNumbering(
            data: IInsertBatesNumberingData,
        ): Promise<IUndoResponse>;
        insertBlankPages(data: IInsertBlankPagesData$1): Promise<IUndoResponse>;
        insertChar(data: IInsertCharData): Promise<IUndoResponse>;
        insertDuplicatePages(
            data: IInsertDuplicatePagesData$1,
        ): Promise<IUndoResponse>;
        insertHeader(data: IInsertHeaderData): Promise<IUndoResponse>;
        insertImageContentElement(data: IInsertImageData): Promise<IUndoResponse>;
        insertPageNumber(data: IInsertPageNumberData): Promise<IUndoResponse>;
        insertPagesFromFile(
            data: IInsertPagesFromFileData$1,
        ): Promise<IUndoResponse>;
        insertWatermark(data: IInsertWatermarkData): Promise<IUndoResponse>;
        mergeTextBlocks(data: IMergeTextBlocksData): Promise<IUndoResponse>;
        moveBookmark(data: IMoveBookmarkData): Promise<IUndoResponse>;
        movePages(data: IMovePagesData): Promise<IUndoResponse>;
        ocr(data: IOcrCommandData): Promise<IOcrCommandResult>;
        orderAnnotation(data: IOrderAnnotationData): Promise<IUndoResponse>;
        pasteContentElement(data: IPasteContentElementData): Promise<IUndoResponse>;
        pasteTextBlock(data: IPasteTextBlockData): Promise<IUndoResponse>;
        patchBookmark(data: IBookmarkRequestData): Promise<IUndoResponse>;
        replaceText(data: IReplaceTextData): Promise<IUndoResponse>;
        replaceWithBlankPages(
            data: IReplaceWithBlankPagesData$1,
        ): Promise<IUndoResponse>;
        replaceWithDuplicatePages(
            data: IReplaceWithDuplicatePagesData$1,
        ): Promise<IUndoResponse>;
        replaceWithPagesFromFile(
            data: IReplaceWithPagesFromFileData$1,
        ): Promise<IUndoResponse>;
        resetAcroformsFdfData(): Promise<IUndoResponse>;
        resizePages(data: IChangeSizeData): Promise<IUndoResponse>;
        reversePage(data: IReversePages): Promise<IUndoResponse>;
        rotatePages(data: IRotatePagesData): Promise<IUndoResponse>;
        saveAttachment(data: ISaveAttachmentData): Promise<IUndoResponse>;
        setOCGroupState(data: IChangeLayerStateData): Promise<IUndoResponse>;
        setSecurityPermissions(
            data: ISecuritySaveSettingsData,
        ): Promise<IUndoResponse>;
        signPdf(data: ISignPdfCommandData): Promise<ISignPdfCommandResult>;
        transformClip(data: ITransformClipData): Promise<IUndoResponse>;
        transformContent(data: IDeskewData): Promise<IUndoResponse>;
        transformTextBlock(data: ITransformTextBlockData): Promise<IUndoResponse>;
        translate(data: ITranslateCommandData): Promise<ITranslateCommandResult>;
        whiteoutPage(data: IDoWhiteoutData): Promise<IUndoResponse>;
    }

    Hierarchy (View Summary)

    Index

    Methods

    • Parameters

      • pageIndex: number
      • parentIndex: number[]
      • Optionaltitle: string

      Returns Promise<IUndoResponse>

    • Parameters

      • pageIndex: number
      • parentIndex: number[]
      • Optionaltitle: string

      Returns Promise<IUndoResponse>

    • Parameters

      • pageIndex: number
      • parentIndex: number[]
      • Optionaltitle: string

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IDeleteAnnotationData$1

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IInsertBlankPagesData$1

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IInsertDuplicatePagesData$1

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IInsertPagesFromFileData$1

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IReplaceWithBlankPagesData$1

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IReplaceWithDuplicatePagesData$1

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IReplaceWithPagesFromFileData$1

      Returns Promise<IUndoResponse>