Some test text!

Search
Hamburger Icon

Android / Guides / Remove annotations

Deleting annotations in Android

Using the Apryse library, you can delete a single annotation, delete all the annotations on a page, or delete all the annotations in a PDF document.

The Apryse library has an annotation list dialog fragment. The dialog fragment allows users to delete annotations easily. For more information, see annotation dialog fragment .
To delete an annotation, you need the page number of the annotation. To avoid looping through the whole document to find the page number of the annotation, we recommend you always keep track of the page number when you get an annotation.

Delete an annotation

To delete an annotation, you need to lock PDFViewCtrl first. See the section on document locking for more information.

You can delete an annotation as follows:

public void deleteAnnotation(final PDFViewCtrl pdfViewCtrl, final Annot annot, final int pageNum) throws Exception {
    // Lock the document first, because accessing annotation/doc information isn't thread-safe.
    pdfViewCtrl.docLock(true, new PDFViewCtrl.LockRunnable() {
        @Override
        public void run() throws Exception {
            Page page = pdfViewCtrl.getDoc().getPage(pageNum);
            page.annotRemove(annot);
            pdfViewCtrl.update(annot, pageNum);
        }
    });
}

Delete all annotations on a page

The following snippet shows how to enumerate all the annotations on a page, as well as how to delete them.

void deleteAnnotationsOnPage(final PDFViewCtrl pdfViewCtrl, final int pageNum) throws Exception {
    // Lock the document first, because accessing annotation/doc information isn't thread-safe.
    pdfViewCtrl.docLock(true, new PDFViewCtrl.LockRunnable() {
        @Override
        public void run() throws Exception {
            Page page = pdfViewCtrl.getDoc().getPage(pageNum);
            int annotCount = page.getNumAnnots();
            while (annotCount > 0) {
                page.annotRemove(0);
                annotCount = page.getNumAnnots();
            }
            pdfViewCtrl.update(true);
        }
    });
}

Delete all the annotations in a PDF document

The following snippet shows how to traverse all the pages in a PDF document and delete all the annotations.

void deleteAllAnnotations(final PDFViewCtrl pdfViewCtrl) throws Exception {
    // Lock the document first, because accessing annotation/doc information isn't thread-safe.
    pdfViewCtrl.docLock(true, new PDFViewCtrl.LockRunnable() {
        @Override
        public void run() throws Exception {
            PDFDoc pdfDoc = pdfViewCtrl.getDoc();
            PageIterator itr = pdfDoc.getPageIterator();
            while (itr.hasNext()) {
                Page page = (Page) itr.next();
                int annotCount = page.getNumAnnots();
                while (annotCount > 0) {
                    page.annotRemove(0);
                    annotCount = page.getNumAnnots();
                }
            }
            pdfViewCtrl.update(true);
        }
    });
}

Trial setup questions? Ask experts on Discord
Need other help? Contact Support
Pricing or product questions? Contact Sales