Xamarin.Android

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PdfCircleAnnotation

    Show / Hide Table of Contents

    Class PdfCircleAnnotation

    Represents a PDF circle annotation

    Inheritance
    System.Object
    PdfAnnotation
    PdfCircleAnnotation
    PdfEllipseAnnotation
    Implements
    System.ComponentModel.INotifyPropertyChanged
    Inherited Members
    PdfAnnotation.SetAppearance(Boolean)
    PdfAnnotation.CalculateBounds(RectangleF, PdfPage, PdfLoadedPage)
    PdfAnnotation.SetValues(String, String)
    PdfAnnotation.CalculateTemplateBounds(RectangleF, PdfPageBase, PdfTemplate)
    PdfAnnotation.CalculateTemplateBounds(RectangleF, PdfPageBase, PdfTemplate, Boolean, PdfGraphics)
    PdfAnnotation.CalculateTemplateBounds(RectangleF, PdfPageBase, PdfTemplate, Boolean)
    PdfAnnotation.CheckFlatten()
    PdfAnnotation.Color
    PdfAnnotation.Opacity
    PdfAnnotation.InnerColor
    PdfAnnotation.Bounds
    PdfAnnotation.Location
    PdfAnnotation.Size
    PdfAnnotation.Page
    PdfAnnotation.Text
    PdfAnnotation.Author
    PdfAnnotation.Subject
    PdfAnnotation.ModifiedDate
    PdfAnnotation.AnnotationFlags
    PdfAnnotation.Flatten
    PdfAnnotation.FlattenPopUps
    PdfAnnotation.PdfTag
    PdfAnnotation.Layer
    PdfAnnotation.Rotate
    PdfAnnotation.Name
    PdfAnnotation.PropertyChanged
    Namespace: Syncfusion.Pdf.Interactive
    Assembly: Syncfusion.Pdf.Portable.dll
    Syntax
    public class PdfCircleAnnotation : PdfAnnotation, IPdfWrapper, INotifyPropertyChanged

    Constructors

    PdfCircleAnnotation(RectangleF)

    Initialise the new instance of the circle annotation with bounds.

    Declaration
    public PdfCircleAnnotation(RectangleF rectangle)
    Parameters
    Type Name Description
    RectangleF rectangle

    Used to represent the bounds of the annotation

    PdfCircleAnnotation(RectangleF, String)

    Initialise the new instance of the circle annotation with bounds and text.

    Declaration
    public PdfCircleAnnotation(RectangleF rectangle, string text)
    Parameters
    Type Name Description
    RectangleF rectangle

    Used to represent the bounds of the annotation

    System.String text

    Used to represents the text of the annotation

    Properties

    Border

    Get or set the border style of the circle annotaion.

    Declaration
    public LineBorder Border { get; set; }
    Property Value
    Type Description
    LineBorder

    Comments

    Gets the annotation comments

    Declaration
    public PdfPopupAnnotationCollection Comments { get; }
    Property Value
    Type Description
    PdfPopupAnnotationCollection
    Examples
    //Create a new PDF document.
    PdfDocument document = new PdfDocument();
    //Create a new page.
    PdfPage page = document.Pages.Add();
    //To specify the line end points
    RectangleF rectangle = new RectangleF(10, 40, 30, 30);
    //Create a new line annotation and set properties.
    PdfCircleAnnotation circleAnnotation = new PdfCircleAnnotation(rectangle);
    circleAnnotation.Text = "Circle";
    //Add comment state
    PdfPopupAnnotation popupComments = new PdfPopupAnnotation();
    popupComments.Author = "TestAuthor";
    popupComments.Text = "Test Text";
    circleAnnotation.Comments.Add(popupComments);
    //Get annotation comments
    PdfPopupAnnotationCollection commentsCollection = circleAnnotation.Comments;
    //Saves the document to disk.
    document.Save("Output.pdf");
    document.Close(true);
    Dim document As PdfDocument = New PdfDocument
    Dim page As PdfPage = document.Pages.Add
    Dim rectangle As RectangleF = New RectangleF(10, 40, 30, 30)
    Dim circleAnnotation As PdfCircleAnnotation = New PdfCircleAnnotation(rectangle)
    circleAnnotation.Text = "Circle"
    Dim popupComments As PdfPopupAnnotation = New PdfPopupAnnotation
    popupComments.Author = "TestAuthor"
    popupComments.Text = "Test Text"
    circleAnnotation.Comments.Add(popupComments)
    Dim commentsCollection As PdfPopupAnnotationCollection = circleAnnotation.Comments
    'Saves the document to disk.
    document.Save("Output.pdf")
    document.Close(true)

    ReviewHistory

    Gets the annotation reviews

    Declaration
    public PdfPopupAnnotationCollection ReviewHistory { get; }
    Property Value
    Type Description
    PdfPopupAnnotationCollection
    Examples
     //Create a new PDF document.
    PdfDocument document = new PdfDocument();
    //Create a new page.
    PdfPage page = document.Pages.Add();
    //To specify the line end points
    RectangleF rectangle = new RectangleF(10, 40, 30, 30);
    //Create a new line annotation and set properties.
    PdfCircleAnnotation circleAnnotation = new PdfCircleAnnotation(rectangle);
    circleAnnotation.Text = "Circle";
    //Add Review state
    PdfPopupAnnotation popup = new PdfPopupAnnotation();
    popup.State = PdfAnnotationState.Accepted;
    popup.StateModel = PdfAnnotationStateModel.Review;
    popup.Text = "Hello PDF Comments";
    popup.Author = "Test1";
    circleAnnotation.ReviewHistory.Add(popup);
    //Get Review history
    PdfPopupAnnotationCollection reviewCollection = circleAnnotation.ReviewHistory;
    //Saves the document to disk.
    document.Save("Output.pdf");
    document.Close(true);
    Dim document As PdfDocument = New PdfDocument
    Dim page As PdfPage = document.Pages.Add
    Dim rectangle As RectangleF = New RectangleF(10, 40, 30, 30)
    Dim circleAnnotation As PdfCircleAnnotation = New PdfCircleAnnotation(rectangle)
    circleAnnotation.Text = "Circle"
    Dim popup As PdfPopupAnnotation = New PdfPopupAnnotation
    popup.State = PdfAnnotationState.Accepted
    popup.StateModel = PdfAnnotationStateModel.Review
    popup.Text = "Hello PDF Comments"
    popup.Author = "Test1"
    circleAnnotation.ReviewHistory.Add(popup)
    Dim reviewCollection As PdfPopupAnnotationCollection = circleAnnotation.ReviewHistory
    'Saves the document to disk.
    document.Save("Output.pdf")
    document.Close(true)

    Methods

    Initialize()

    Initializes annotation object.

    Declaration
    protected override void Initialize()
    Overrides
    PdfAnnotation.Initialize()

    Save()

    Saves an annotation.

    Declaration
    protected override void Save()
    Overrides
    PdfAnnotation.Save()

    Implements

    System.ComponentModel.INotifyPropertyChanged
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved