Table of Contents

Class PdfLoadedPopupAnnotation

Namespace
Syncfusion.Pdf.Interactive
Assembly
Syncfusion.Pdf.Portable.dll

Represents the loaded pop up annotation class.

public class PdfLoadedPopupAnnotation : PdfLoadedStyledAnnotation, INotifyPropertyChanged
Inheritance
PdfLoadedPopupAnnotation
Implements
Inherited Members

Examples

//Load an existing document.
PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Gets the annotation from loaded document.
PdfLoadedPopupAnnotation popupAnnotation = document.Pages[1].Annotations[5] as PdfLoadedPopupAnnotation;
//Sets the popup annotation border
popupAnnotation.Border.Width = 4;
popupAnnotation.Border.HorizontalRadius = 20;
popupAnnotation.Border.VerticalRadius = 30;
//Set the popup icon
popupAnnotation.Icon = PdfPopupIcon.Key;
//Save the document.
document.Save("popupAnnotation.pdf");
document.Close(true);
'Load an existing document.
Dim document As New PdfLoadedDocument("..\..\Annotations.pdf")
'Gets the annotation from loaded document.
Dim popupAnnotation As PdfLoadedPopupAnnotation = document.Pages(1).Annotations(5)
'Sets the popup annotation border
popupAnnotation.Border.Width = 4
popupAnnotation.Border.HorizontalRadius = 20
popupAnnotation.Border.VerticalRadius = 30
'Set the popup icon
popupAnnotation.Icon = PdfPopupIcon.Key
'Save the document.
document.Save("popupAnnotation.pdf")
document.Close(True)

Remarks

This PdfLoadedPopupAnnotation class is used to load the pop up annotation from the PDF document. Please refer the UG docuemntation link for more details.

Properties

Comments

Gets the annotation Comments history.

public PdfLoadedPopupAnnotationCollection Comments { get; }

Property Value

PdfLoadedPopupAnnotationCollection

The Comments collection of the popup annotation.

Examples

//Load an existing document.
PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfPopupAnnotation
PdfLoadedPopupAnnotation  popup = document.Pages[0].Annotations[0] as PdfLoadedPopupAnnotation;
//Get the Comments collection
PdfLoadedPopupAnnotationCollection CommentsCollection = popup.Comments;
//save the document
document.Save("PopupAnnotation.pdf");
//Close the docuemnt
document.Close(true);
'Load an existing document.
Dim document As New PdfLoadedDocument("..\..\Annotations.pdf")
'Load the existing PdfPopupAnnotation
Dim popup As PdfLoadedFreeTextAnnotation = document.Pages(0).Annotations(0)
'Get the Comments collection
Dim CommentsCollection As PdfLoadedPopupAnnotationCollection = popup.Comments
'save the document
document.Save("PopupAnnotation.pdf")
'Close the document.
document.Close(True)
See Also

Icon

Gets or sets the icon of the annotation.

public PdfPopupIcon Icon { get; set; }

Property Value

PdfPopupIcon

Examples

The PdfPopupIcon, provides icons to the annotation

//Load an existing document.
PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Gets the annotation from loaded document.
PdfLoadedPopupAnnotation popupAnnotation = document.Pages[1].Annotations[5] as PdfLoadedPopupAnnotation;
//Set the PDF popup icon
popupAnnotation.Icon = PdfPopupIcon.Key;
//Save the document.
document.Save("popupAnnotation.pdf");
document.Close(true);
'Load an existing document.
Dim document As New PdfLoadedDocument("..\..\Annotations.pdf")
'Gets the annotation from loaded document.
Dim popupAnnotation As PdfLoadedPopupAnnotation = document.Pages(1).Annotations(5)
'Set the PDF popup icon
popupAnnotation.Icon = PdfPopupIcon.Key
'Save the document.
document.Save("popupAnnotation.pdf")
document.Close(True)
See Also

IconName

Gets or sets the pop-up icon name to the text annotation.

public string IconName { get; set; }

Property Value

string

Examples

//Load an existing document.
PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Gets the annotation from loaded document.
PdfLoadedPopupAnnotation popupAnnotation = document.Pages[1].Annotations[5] as PdfLoadedPopupAnnotation;
//get the PDF popup icon
string iconName = popupAnnotation.IconName;
//Save the document.
document.Save("popupAnnotation.pdf");
document.Close(true);
'Load an existing document.
Dim document As New PdfLoadedDocument("..\..\Annotations.pdf")
'Gets the annotation from loaded document.
Dim popupAnnotation As PdfLoadedPopupAnnotation = document.Pages(1).Annotations(5)
'Set the PDF popup icon
Dim iconName As String = popupAnnotation.IconName
'Save the document.
document.Save("popupAnnotation.pdf")
document.Close(True)

Remarks

UTF-8 text will not be supported in icon names.

See Also

Open

Gets or sets the open option of the popup annotation.

public bool Open { get; set; }

Property Value

bool

if true open,otherwise not open

Examples

//Load an existing document.
PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Gets the annotation from loaded document.
PdfLoadedPopupAnnotation popupAnnotation = document.Pages[1].Annotations[5] as PdfLoadedPopupAnnotation;
//Set the popup annotation open option
popupAnnotation.Open = true
//Save the document.
document.Save("popupAnnotation.pdf");
document.Close(true);
'Load an existing document.
Dim document As New PdfLoadedDocument("..\..\Annotations.pdf")
'Gets the annotation from loaded document.
Dim popupAnnotation As PdfLoadedPopupAnnotation = document.Pages(1).Annotations(5) 
'Set the popup annotation open option
popupAnnotation.Open = True
'Save the document.
document.Save("popupAnnotation.pdf")
document.Close(True)
See Also

ReviewHistory

Gets the annotation review history.

public PdfLoadedPopupAnnotationCollection ReviewHistory { get; }

Property Value

PdfLoadedPopupAnnotationCollection

The review collection of the popup annotation.

Examples

//Load an existing document.
PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfPopupAnnotation
PdfLoadedPopupAnnotation  popup = document.Pages[0].Annotations[0] as PdfLoadedPopupAnnotation;
//Get the review collection
PdfLoadedPopupAnnotationCollection reviewCollection = popup.ReviewHistory;
//save the document
document.Save("PopupAnnotation.pdf");
//Close the docuemnt
document.Close(true);
'Load an existing document.
Dim document As New PdfLoadedDocument("..\..\Annotations.pdf")
'Load the existing PdfPopupAnnotation
Dim popup As PdfLoadedFreeTextAnnotation = document.Pages(0).Annotations(0)
'Get the review collection
Dim reviewCollection As PdfLoadedPopupAnnotationCollection = popup.ReviewHistory
'save the document
document.Save("PopupAnnotation.pdf")
'Close the document.
document.Close(True)
See Also

State

Get or sets the annotation State.

public PdfAnnotationState State { get; set; }

Property Value

PdfAnnotationState

Examples

//Load an existing document.
PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfFreeTextAnnotation
PdfLoadedFreeTextAnnotation  free = document.Pages[0].Annotations[0] as PdfLoadedFreeTextAnnotation;
//Get the review collection
PdfLoadedPopupAnnotationCollection reviewCollection = free.ReviewHistory;
foreach (PdfLoadedPopupAnnotation popup in reviewCollection){
//Gets the annotation state
PdfAnnotationState state = popup.AnnotationState;
//Gets the annotation state model 
PdfAnnotationStateModel model = popup.AnnotationStateModel;
}
//save the document
document.Save("FreetextAnnotation.pdf");
//Close the docuemnt
document.Close(true);
'Load an existing document.
Dim document As New PdfLoadedDocument("..\..\Annotations.pdf")
'Load the existing PdfFreeTextAnnotation
Dim free As PdfLoadedFreeTextAnnotation = document.Pages(0).Annotations(0)
'Get the review collection
Dim reviewCollection As PdfLoadedPopupAnnotationCollection = free.ReviewHistory
For Each popup As PdfLoadedPopupAnnotation In reviewCollection
'Get the annotation state
Dim state As PdfAnnotationState = popup.AnnotationState
'Get the annotation state model
Dim model As PdfAnnotationStateModel = popup.AnnotationStateModel
Next
'save the document
document.Save("FreetextAnnotation.pdf")
'Close the document.
document.Close(True)
See Also

StateModel

Get or sets the annotation State Model.

public PdfAnnotationStateModel StateModel { get; set; }

Property Value

PdfAnnotationStateModel

Examples

//Load an existing document.
PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfFreeTextAnnotation
PdfLoadedFreeTextAnnotation  free = document.Pages[0].Annotations[0] as PdfLoadedFreeTextAnnotation;
//Get the review collection
PdfLoadedPopupAnnotationCollection reviewCollection = free.ReviewHistory;
foreach (PdfLoadedPopupAnnotation popup in reviewCollection){
//Gets the annotation state
PdfAnnotationState state = popup.AnnotationState;
//Gets the annotation state model 
PdfAnnotationStateModel model = popup.AnnotationStateModel;
}
//save the document
document.Save("FreetextAnnotation.pdf");
//Close the docuemnt
document.Close(true);
'Load an existing document.
Dim document As New PdfLoadedDocument("..\..\Annotations.pdf")
'Load the existing PdfFreeTextAnnotation
Dim free As PdfLoadedFreeTextAnnotation = document.Pages(0).Annotations(0)
'Get the review collection
Dim reviewCollection As PdfLoadedPopupAnnotationCollection = free.ReviewHistory
For Each popup As PdfLoadedPopupAnnotation In reviewCollection
'Get the annotation state
Dim state As PdfAnnotationState = popup.AnnotationState
'Get the annotation state model
Dim model As PdfAnnotationStateModel = popup.AnnotationStateModel
Next
'save the document
document.Save("FreetextAnnotation.pdf")
'Close the document.
document.Close(True)
See Also

Methods

CreateApperance()

Modify popup annotation appearance

protected void CreateApperance()
See Also

Save()

Saves an annotation.

protected override void Save()
See Also

See Also

PdfLoadedAttachmentAnnotation
PdfLoadedDocumentLinkAnnotation
PdfLoadedFileLinkAnnotation
PdfLoadedLineAnnotation
PdfLoadedRubberStampAnnotation
PdfLoadedSoundAnnotation
PdfLoadedTextMarkupAnnotation
PdfLoadedTextWebLinkAnnotation
PdfLoadedUriAnnotation