|
Foxit PDF SDK
|
Public Member Functions | |
| Popup () | |
| Constructor. | |
| Popup (Annot annot) | |
| Constructor, with parent class object. More... | |
| bool | GetOpenStatus () |
| Get open status. More... | |
| Markup | GetParent () |
| Get related parent markup annotation. More... | |
| void | SetOpenStatus (bool status) |
| Set open status. More... | |
Public Member Functions inherited from foxit.pdf.annots.Annot | |
| Annot (PDFPage page, PDFDictionary annot_dict) | |
| Constructor, with PDF page and annotation's PDF dictionary. More... | |
| Annot (Annot annot) | |
| Constructor, with another annotation object. More... | |
| Annot () | |
| Constructor. | |
| PDFStream | GetAppearanceStream (Annot.AppearanceType type, string appearance_state) |
| Get annotation's appearance stream with specified type and state. More... | |
| int | GetBorderColor () |
| Get border color. More... | |
| BorderInfo | GetBorderInfo () |
| Get border information. More... | |
| string | GetContent () |
| Get content. More... | |
| RectI | GetDeviceRect (Matrix2D matrix) |
| Get annotation rectangle in device coordinate system. More... | |
| PDFDictionary | GetDict () |
| Get annotation's dictionary object. More... | |
| Matrix2D | GetDisplayMatrix (Matrix2D page_display_matrix) |
| Get the display matrix, from PDF coordinate system to targeted device coordinate system. More... | |
| int | GetFlags () |
| Get annotation flags. More... | |
| int | GetIndex () |
| Get the index of current annotation in the page which current annotation belongs to. More... | |
| DateTime | GetModifiedDateTime () |
| Get last modified date time. More... | |
| PDFDictionary | GetOptionalContent () |
| Get the PDF dictionary of annotation's optional content. More... | |
| PDFPage | GetPage () |
| Get the related PDF page. More... | |
| RectF | GetRect () |
| Get rectangle, in PDF coordinate system. More... | |
| Annot.Type | GetType () |
| Get actual annotation type of current annotation. More... | |
| string | GetUniqueID () |
| Get unique ID. More... | |
| bool | HasProperty (Annot.Property property) |
| Whether current annotation has the specified annotation's property. More... | |
| bool | IsEmpty () |
| Check whether current object is empty or not. More... | |
| bool | IsMarkup () |
| Check if current annotation is a markup annotation. More... | |
| bool | Move (RectF rect) |
| Move current annotation to a new position, specified by a new rectangle in [PDF coordinate system] (foxit.pdf.PDFPage). More... | |
| bool | Move (RectF rect, bool is_reset_appearance) |
| Move current annotation to a new position, specified by a new rectangle in [PDF coordinate system] (foxit.pdf.PDFPage). More... | |
| bool | RemoveProperty (Annot.Property property) |
| Remove a specified annotation's property. More... | |
| bool | ResetAppearanceStream () |
| Reset appearance stream. More... | |
| bool | ResetAppearanceStream (bool is_generate_new_appearance_obj) |
| Reset appearance stream. More... | |
| void | SetBorderColor (int color) |
| Set border color. More... | |
| void | SetBorderInfo (BorderInfo border) |
| Set border information. More... | |
| void | SetContent (string content) |
| Set content. More... | |
| void | SetFlags (int flags) |
| Set annotation flags. More... | |
| void | SetModifiedDateTime (DateTime date_time) |
| Set last modified date time. More... | |
| void | SetUniqueID (string unique_id) |
| Set unique ID. More... | |
A pop-up annotation displays text in a pop-up window for entry and editing. It typically does not appear alone but is associated with a markup annotation, its parent annotation, and is used for editing the parent's text.
Class foxit.pdf.annots.Popup is derived from class Annot and also offers functions to get/set pop-up annotation's properties. Pop-up annotation has no appearance stream or associated actions of its own, so function Annot.ResetAppearanceStream will always return false for a pop-up annotation.
|
inline |
Constructor, with parent class object.
| [in] | annot | Parent class object. |
|
inline |
Get open status.
Open status is a boolean value that specifies whether a note annotation should initially be displayed open:
true means the note annotation should be initially be displayed open.
false means the note annotation should be initially be displayed closed.
|
inline |
Get related parent markup annotation.
|
inline |
Set open status.
Open status is a boolean value that specifies whether a note annotation should initially be displayed open:
true means the note annotation should be initially be displayed open.
false means the note annotation should be initially be displayed closed.
| [in] | status | The new open status value. |