-
Notifications
You must be signed in to change notification settings - Fork 41
Popup Annotation #551
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Popup Annotation #551
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: | ||
|
|
||
| <snippet id='libraries-pdf-model-annotations-popup-create'/> | ||
|
|
||
| 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**: | ||
|
|
||
| <snippet id='libraries-pdf-model-annotations-popup-create-with-fixedcontenteditor'/> | ||
|
|
||
| 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%}) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Consider clarifying that the popup annotation is initially hidden and only becomes visible when activated to more accurately reflect its behavior.