Foxit PDF SDK
fsdk.Popup Class Reference

Public Member Functions

def GetOpenStatus ()
 Get open status.
More...
 
def GetParent ()
 Get related parent markup annotation.
More...
 
def SetOpenStatus (status)
 Set open status.
More...
 

Detailed Description

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 fsdk.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 fsdk.Annot.ResetAppearanceStream will always return false for a pop-up annotation.

See also
Annot

Member Function Documentation

◆ GetOpenStatus()

def fsdk.Popup.GetOpenStatus ( )

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.


Returns
Open status.

◆ GetParent()

def fsdk.Popup.GetParent ( )

Get related parent markup annotation.

Returns
The related parent markup annotation. If the return value of function fsdk.Annot.IsEmpty (inherited from Markup 's parent class) for the returned markup annotation is true, that means current pop-up annotation does not have a markup annotation.

◆ SetOpenStatus()

def fsdk.Popup.SetOpenStatus (   status)

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.


Parameters
[in]statusThe new open status value.
Returns
None.