All docs
V21.2
21.2
21.1
The page you are viewing does not exist in version 21.1. This link will take you to the root page.
20.2
The page you are viewing does not exist in version 20.2. This link will take you to the root page.
20.1
The page you are viewing does not exist in version 20.1. This link will take you to the root page.
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

PdfSquareAnnotationFacade Class

Exposes members used to organize square annotations without access to their inner structure.

Namespace: DevExpress.Pdf

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

Declaration

public class PdfSquareAnnotationFacade :
    PdfShapeAnnotationFacade

Remarks

Create Square Annotations

The code sample below creates a square annotation.

square annotation

using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
{
    // Load a document
    processor.LoadDocument("..\\..\\Document.pdf");

    // Access the first page properties
    PdfPageFacade pageFacade = processor.DocumentFacade.Pages[0];

    // Define the area to add an annotation
    PdfRectangle rectangle = new PdfRectangle(663, 526, 763, 576);

    // Create a square annotation
    PdfSquareAnnotationFacade squareAnnotation = pageFacade.AddSquareAnnotation(rectangle);

    // Specify annotation parameters
    squareAnnotation.Author = "Nancy Davolio";
    squareAnnotation.Contents = "Made in PDF Document API";

    // Save the result
    processor.SaveDocument("..\\..\\Result.pdf");
}

Edit Square Annotations

The PdfPageFacade.Annotations property returns all page annotation properties. You can filter square annotation properties, cast them to the PdfSquareAnnotationFacade class, and use class properties to modify annotation parameters.

The code sample below retrieves all square annotations on the first page and changes their border and fill color.

edited square annotation

using DevExpress.Pdf;
using System.Linq;

using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
{
    // Load a document
    processor.LoadDocument("..\\..\\Document.pdf");

    // Access the first page properties
    PdfPageFacade pageFacade = processor.DocumentFacade.Pages[0];

    // Retrieve all square annotations
    var squareAnnotations = pageFacade.Annotations.Where
      (annotation => annotation.Type == PdfAnnotationType.Square);
    foreach (PdfSquareAnnotationFacade square in squareAnnotations)
    {
        // Change annotation parameters
        square.BorderWidth = 2.5;
        square.InteriorColor = new PdfRGBColor(1.00, 1.00, 0.00);
        square.Opacity = 0.7;
    }
    // Save the result
    processor.SaveDocument("..\\..\\Result.pdf");
}

Flatten Square Annotations

Call one of the following methods to flatten an annotation:

Method Description
PdfDocumentFacade.FlattenAnnotations Flattens document annotations.
PdfPageFacade.FlattenAnnotations Flattens annotations of a specific page.
PdfAnnotationFacade.Flatten() Flattens a specific annotation.

The code sample below flattens all square annotations on the first page.

using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
{
    // Load a document
    processor.LoadDocument("..\\..\\Document.pdf");

    // Access the first page properties
    PdfPageFacade pageFacade = processor.DocumentFacade.Pages[0];

    // Flatten all square annotations
    pageFacade.FlattenAnnotations(PdfAnnotationType.Square);

    // Save the result
    processor.SaveDocument("..\\..\\Result.pdf");
}

Remove Square Annotations

Call the PdfAnnotationFacade.Remove() method to remove a specific annotation.

The code sample below removes all square annotations from the first page.

using DevExpress.Pdf;
using System.Linq;

using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
{
    // Load a document
    processor.LoadDocument("..\\..\\Document.pdf");

    // Access the first page properties
    PdfPageFacade pageFacade = processor.DocumentFacade.Pages[0];

    // Retrieve all square annotations
    var squareAnnotations = pageFacade.Annotations.Where
      (annotation => annotation.Type == PdfAnnotationType.Square).ToList();
    foreach (PdfSquareAnnotationFacade square in squareAnnotations)
    {
        // Remove each annotation
        square.Remove();
    }
    // Save the result
    processor.SaveDocument("..\\..\\Result.pdf");
}
See Also