Back to Devexpress

PdfMarkupAnnotationReview Class

officefileapi-devexpress-dot-pdf-2d2f61b1.md

latest3.4 KB
Original Source

PdfMarkupAnnotationReview Class

Represents the review added to an annotation or comment.

Namespace : DevExpress.Pdf

Assembly : DevExpress.Pdf.v25.2.Core.dll

NuGet Package : DevExpress.Pdf.Core

Declaration

csharp
public class PdfMarkupAnnotationReview
vb
Public Class PdfMarkupAnnotationReview

Remarks

Add a Review

Call the PdfMarkupAnnotationData.AddReview method to add a review to the annotation.

The code sample below gets all annotations and adds a review to the first annotation:

csharp
using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
{
    processor.LoadDocument("..\\..\\Document.pdf");

    var annotations = processor.GetMarkupAnnotationData(1);
    annotations[0].AddReview("Borman Aaron Lewis", PdfAnnotationReviewStatus.Completed);
}
vb
Using processor As New PdfDocumentProcessor()
    processor.LoadDocument("..\..\Document.pdf")

    Dim annotations = processor.GetMarkupAnnotationData(1)
    annotations(0).AddReview("Borman Aaron Lewis", PdfAnnotationReviewStatus.Completed)
End Using

The PdfMarkupAnnotationComment.AddReview method adds a review to the comment.

csharp
private static void AddAnnotationComments(PdfMarkupAnnotationData annotation)
{
    PdfMarkupAnnotationComment comment =
    annotation.AddReply("Reviewer", "Done");
    comment.Subject = "Proofread";

    PdfMarkupAnnotationComment nestedComment =
    comment.AddReply(annotation.Author, "Thanks");
    nestedComment.Subject = "Reviewed";
}
vb
Private Shared Sub AddAnnotationComments(ByVal annotation As PdfMarkupAnnotationData)
    Dim comment As PdfMarkupAnnotationComment = annotation.AddReply("Reviewer", "Done")
    comment.Subject = "Proofread"

    Dim nestedComment As PdfMarkupAnnotationComment = comment.AddReply(annotation.Author, "Thanks")
    nestedComment.Subject = "Reviewed"
End Sub

Access Reviews

The PdfMarkupAnnotationData and PdfMarkupAnnotationComment classes have the Reviews property that gets all reviews added to the annotation or comment. The retrieved list of PdfMarkupAnnotationReview objects allows you to check the reviews’ author and status.

Remove Reviews

Call the PdfMarkupAnnotationData.ClearReviews() or PdfMarkupAnnotationComment.ClearReviews() method to clear all annotation or comment reviews.

Inheritance

Object PdfMarkupAnnotationReview

See Also

PdfMarkupAnnotationReview Members

DevExpress.Pdf Namespace