diff --git a/libraries/radpdfprocessing/model/annotations/overview.md b/libraries/radpdfprocessing/model/annotations/overview.md index 3172ad3e..358e4aef 100644 --- a/libraries/radpdfprocessing/model/annotations/overview.md +++ b/libraries/radpdfprocessing/model/annotations/overview.md @@ -29,7 +29,8 @@ The abstract **Annotation** element associates an object with a location on a [R |[Line]({%slug radpdfprocessing-model-annotations-line%})|Line annotations display a single straight line on the page.| |[Stamp]({%slug radpdfprocessing-model-annotations-stamp%})|Stamp annotations display text or graphics intended to look as if they were stamped on the page with a rubber stamp.| |[TextMarkup]({%slug radpdfprocessing-model-annotations-text-markup%})| Text markup annotations appear as **Highlights**, **Underlines**, **Strikeouts** or **Squiggly** underlines in the text of a document. When opened, they display a pop-up window containing the text of the associated note.| - +|[Popup]({%slug radpdfprocessing-model-annotations-popup%})|A popup annotation is associated with another [markup annotation]({%slug radpdfprocessing-model-annotations-overview%}) and displays its content in a pop-up window for entry and editing. It typically appears as a pop-up note.| + * **Border**: Represents the annotation borders. This property is of type [AnnotationBorder](https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Fixed.Model.Annotations.AnnotationBorder.html). * **IsPrintable**: A boolean value that indicates whether the annotation instance should be visualized when printing the document. When set to *false*, the annotation won't appear when the document is printed. diff --git a/libraries/radpdfprocessing/model/annotations/popup.md b/libraries/radpdfprocessing/model/annotations/popup.md new file mode 100644 index 00000000..bbda6523 --- /dev/null +++ b/libraries/radpdfprocessing/model/annotations/popup.md @@ -0,0 +1,45 @@ +--- +title: Popup +page_title: Popup Annotation +description: Popup annotations display a pop-up window containing comments or notes associated with the document content. +slug: radpdfprocessing-model-annotations-popup +tags: annotation, overview, pdfprocessing, popup +published: True +position: 7 +--- + +# Popup Annotation + +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. + +The **PopupAnnotation** class is a derivative of the **Annotation** class and it exposes the following properties: + +|Property|Description| +|---|---| +|**ParentAnnotation**|Gets or sets the parent [MarkupAnnotation]({%slug radpdfprocessing-model-annotations-overview%}) that this popup is associated with.| +|**IsOpen**|Gets or sets a value indicating whether the popup is initially open.| + +## Creating a PopupAnnotation + +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: + + + +The popup annotation will display the contents of the text annotation in a pop-up window. + +## Creating a PopupAnnotation with FixedContentEditor + +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**: + + + +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. + +## See Also + +* [Annotations Overview]({%slug radpdfprocessing-model-annotations-overview%}) +* [Text Annotation]({%slug radpdfprocessing-model-annotations-text%}) +* [Line Annotation]({%slug radpdfprocessing-model-annotations-line%}) +* [TextMarkup Annotation]({%slug radpdfprocessing-model-annotations-text-markup%}) +* [Stamp Annotation]({%slug radpdfprocessing-model-annotations-stamp%}) +* [FixedContentEditor]({%slug radpdfprocessing-editing-fixedcontenteditor%})