VintaSoft Imaging .NET SDK 11.0
Vintasoft.Imaging.Pdf.Tree.Annotations Namespace / PdfSquareAnnotation Class
Members Example



In This Topic
    PdfSquareAnnotation Class
    In This Topic
    Represents a PDF annotation that displays a square.
    Object Model
    PdfSquareAnnotation ClassPdfAction ClassPdfAnnotationAdditionalActions ClassPdfAnnotationAppearanceGenerator ClassAffineMatrix ClassPdfAnnotationAppearances ClassPdfFileReferenceSpecificationList ClassPdfFileReferenceSpecification ClassPdfBasicObject ClassPdfAnnotationBorderEffect ClassPdfAnnotationBorderStyle ClassPdfDocument ClassPdfIndirectReference ClassPdfOptionalContentGroup ClassPaddingF StructurePdfPage ClassPdfPopupAnnotation ClassPdfAnnotation Class
    Syntax
    'Declaration
     
    Public Class PdfSquareAnnotation 
       Inherits PdfRectangularAnnotation
    public class PdfSquareAnnotation : PdfRectangularAnnotation 
    public __gc class PdfSquareAnnotation : public PdfRectangularAnnotation 
    public ref class PdfSquareAnnotation : public PdfRectangularAnnotation 
    Example
    Here is an example that shows how to create a PDF square annotation:
    ''' <summary>
    ''' Creates the PDF documenet with square annotation.
    ''' </summary>
    ''' <param name="outputPdfFilename">The output PDF filename.</param>
    Public Shared Sub CreatePdfSquareAnnotation(outputPdfFilename As String)
        Using document As New Vintasoft.Imaging.Pdf.PdfDocument(outputPdfFilename, Vintasoft.Imaging.Pdf.PdfFormat.Pdf_14)
            Dim page As Vintasoft.Imaging.Pdf.Tree.PdfPage
                
            ' Add new page
            page = document.Pages.Add(Vintasoft.Imaging.PaperSizeKind.A4)
            page.Annotations = New Vintasoft.Imaging.Pdf.Tree.Annotations.PdfAnnotationList(document)
            Dim annotationRectangle As System.Drawing.RectangleF = page.MediaBox
            annotationRectangle.Inflate(-200, -300)
                
            ' Square annotation
            Dim square As New Vintasoft.Imaging.Pdf.Tree.Annotations.PdfSquareAnnotation(page)
            square.Rectangle = annotationRectangle
            square.BorderWidth = 3
            square.Padding = New Vintasoft.Imaging.PaddingF(square.BorderWidth)
            square.InteriorColor = System.Drawing.Color.Red
            square.Color = System.Drawing.Color.Green
            square.UpdateAppearance()
            page.Annotations.Add(square)
                
            document.SaveChanges()
        End Using
    End Sub
    /// <summary>
    /// Creates the PDF documenet with square annotation.
    /// </summary>
    /// <param name="outputPdfFilename">The output PDF filename.</param>
    public static void CreatePdfSquareAnnotation(string outputPdfFilename)
    {
        using (Vintasoft.Imaging.Pdf.PdfDocument document = new Vintasoft.Imaging.Pdf.PdfDocument(
            outputPdfFilename, Vintasoft.Imaging.Pdf.PdfFormat.Pdf_14))
        {
            Vintasoft.Imaging.Pdf.Tree.PdfPage page;
                
            // Add new page
            page = document.Pages.Add(Vintasoft.Imaging.PaperSizeKind.A4);
            page.Annotations = new Vintasoft.Imaging.Pdf.Tree.Annotations.PdfAnnotationList(document);
            System.Drawing.RectangleF annotationRectangle = page.MediaBox;
            annotationRectangle.Inflate(-200, -300);
                
            // Square annotation
            Vintasoft.Imaging.Pdf.Tree.Annotations.PdfSquareAnnotation square = 
                new Vintasoft.Imaging.Pdf.Tree.Annotations.PdfSquareAnnotation(page);
            square.Rectangle = annotationRectangle;
            square.BorderWidth = 3;
            square.Padding = new Vintasoft.Imaging.PaddingF(square.BorderWidth);
            square.InteriorColor = System.Drawing.Color.Red;
            square.Color = System.Drawing.Color.Green;
            square.UpdateAppearance();
            page.Annotations.Add(square);
                
            document.SaveChanges();
        }
    }
    Inheritance Hierarchy
    Requirements

    Target Platforms: .NET 6; .NET 5; .NET Core 3.1; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

    See Also