|
| 1 | +--- |
| 2 | +title: Popup |
| 3 | +page_title: Popup Annotation |
| 4 | +description: Popup annotations display a pop-up window containing comments or notes associated with the document content. |
| 5 | +slug: radpdfprocessing-model-annotations-popup |
| 6 | +tags: annotation, overview, pdfprocessing, popup |
| 7 | +published: True |
| 8 | +position: 7 |
| 9 | +--- |
| 10 | + |
| 11 | +# Popup Annotation |
| 12 | + |
| 13 | +A **Popup annotation** displays a pop-up window containing text associated with a parent annotation, such as a [Text]({%slug radpdfprocessing-model-annotations-text%}), [Line]({%slug radpdfprocessing-model-annotations-line%}), [TextMarkup]({%slug radpdfprocessing-model-annotations-text-markup%}) or [Stamp]({%slug radpdfprocessing-model-annotations-stamp%}) annotation. When closed, a popup annotation is invisible. When open, it should appear as a pop-up window at a specified location on the page. |
| 14 | + |
| 15 | +The **PopupAnnotation** class is a derivative of the **Annotation** class and it exposes the following properties: |
| 16 | + |
| 17 | +|Property|Description| |
| 18 | +|---|---| |
| 19 | +|**ParentAnnotation**|Gets or sets the parent [MarkupAnnotation]({%slug radpdfprocessing-model-annotations-overview%}) that this popup is associated with.| |
| 20 | +|**IsOpen**|Gets or sets a value indicating whether the popup is initially open.| |
| 21 | + |
| 22 | +## Creating a PopupAnnotation |
| 23 | + |
| 24 | +Popup annotations are typically created in association with another markup annotation, such as Text, Line, TextMarkup or Stamp. The following example shows how to create a PopupAnnotation associated with a TextAnnotation: |
| 25 | + |
| 26 | +<snippet id='libraries-pdf-model-annotations-popup-create'/> |
| 27 | + |
| 28 | +The popup annotation will display the contents of the text annotation in a pop-up window. |
| 29 | + |
| 30 | +## Creating a PopupAnnotation with FixedContentEditor |
| 31 | + |
| 32 | +When creating a TextAnnotation with the [FixedContentEditor]({%slug radpdfprocessing-editing-fixedcontenteditor%})'s **DrawTextAnnotation** method, you can also associate a popup annotation by setting the `addPopup` parameter to **true**: |
| 33 | + |
| 34 | +<snippet id='libraries-pdf-model-annotations-popup-create-with-fixedcontenteditor'/> |
| 35 | + |
| 36 | +This code creates a [TextAnnotation]({%slug radpdfprocessing-model-annotations-text%}) with an associated **PopupAnnotation**. The popup will display the text provided in the method call. |
| 37 | + |
| 38 | +## See Also |
| 39 | + |
| 40 | +* [Annotations Overview]({%slug radpdfprocessing-model-annotations-overview%}) |
| 41 | +* [Text Annotation]({%slug radpdfprocessing-model-annotations-text%}) |
| 42 | +* [Line Annotation]({%slug radpdfprocessing-model-annotations-line%}) |
| 43 | +* [TextMarkup Annotation]({%slug radpdfprocessing-model-annotations-text-markup%}) |
| 44 | +* [Stamp Annotation]({%slug radpdfprocessing-model-annotations-stamp%}) |
| 45 | +* [FixedContentEditor]({%slug radpdfprocessing-editing-fixedcontenteditor%}) |
0 commit comments