Show / Hide Table of Contents

# Class Popup

A pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and editing. It shall not appear alone but is associated with a markup annotation, its parent annotation, and shall be used for editing the parent’s text. It shall have no appearance stream or associated actions of its own and shall be identified by the Popup entry in the parent’s annotation dictionary.

##### Inheritance

object
Annot
Popup

##### Implements

IDisposable

##### Inherited Members

Annot.Dispose()
Annot.Dispose(bool)
Annot.GetHandleInternal()
Annot.GetRefHandleInternal()
Annot.CreateInternal(IntPtr, object)
Annot.Create(SDFDoc, Annot.Type, Rect)
Annot.op_Assign(Annot)
Annot.Equals(object)
Annot.IsValid()
Annot.GetSDFObj()
Annot.GetType()
Annot.IsMarkup()
Annot.GetRect()
Annot.GetVisibleContentBox()
Annot.SetRect(Rect)
Annot.GetContents()
Annot.SetContents(string)
Annot.GetPage()
Annot.SetPage(Page)
Annot.GetUniqueID()
Annot.SetUniqueID(string)
Annot.GetDate()
Annot.SetDate(Date)
Annot.GetFlag(Annot.Flag)
Annot.SetFlag(Annot.Flag, bool)
Annot.GetBorderStyle()
Annot.SetBorderStyle(Annot.BorderStyle)
Annot.GetAppearance()
Annot.GetAppearance(Annot.AnnotationState)
Annot.GetAppearance(Annot.AnnotationState, string)
Annot.SetAppearance(Obj)
Annot.SetAppearance(Obj, Annot.AnnotationState)
Annot.SetAppearance(Obj, Annot.AnnotationState, string)
Annot.RemoveAppearance()
Annot.RemoveAppearance(Annot.AnnotationState)
Annot.RemoveAppearance(Annot.AnnotationState, string)
Annot.Flatten(Page)
Annot.GetActiveAppearanceState()
Annot.SetActiveAppearanceState(string)
Annot.GetColorAsRGB()
Annot.GetColorAsCMYK()
Annot.GetColorAsGray()
Annot.GetColorCompNum()
Annot.SetColor(ColorPt, int)
Annot.SetColor(ColorPt)
Annot.GetStructParent()
Annot.SetStructParent(int)
Annot.GetOptionalContent()
Annot.SetOptionalContent(Obj)
Annot.Resize(Rect)
Annot.GetRotation()
Annot.SetRotation(int)
Annot.RefreshAppearance()
Annot.GetCustomData(string)
Annot.SetCustomData(string, string)
Annot.DeleteCustomData(string)
object.Equals(object, object)
object.GetHashCode()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()

###### Namespace: pdftron.PDF.Annots

###### Assembly: PDFTronDotNet.dll

##### Syntax

    public class Popup : Annot, IDisposable

### Constructors

#### Popup(Annot)

Creates a Popup annotation and initialize it using given annotation object.

##### Declaration

    public Popup(Annot ann)

##### Parameters

Type | Name | Description
--- | --- | ---
Annot | ann | the annot

##### Remarks

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### Popup(Obj)

Creates a Popup annotation and initialize it using given Cos/SDF object.

##### Declaration

    public Popup(Obj d)

##### Parameters

Type | Name | Description
--- | --- | ---
Obj | d | the d

##### Remarks

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

### Methods

#### Create(SDFDoc, Rect)

Creates a new Popup annotation, in the specified document.

##### Declaration

    public static Popup Create(SDFDoc doc, Rect pos)

##### Parameters

Type | Name | Description
--- | --- | ---
SDFDoc | doc | A document to which the Popup annotation is added.
Rect | pos | A rectangle specifying the Popup annotation's bounds, specified in user space coordinates.

##### Returns

Type | Description
--- | ---
Popup | A newly created blank Popup annotation.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### ~Popup()

Releases all resources used by the Popup

##### Declaration

    protected ~Popup()

#### GetParent()

Gets the Parent annotation of the Popup annotation.

##### Declaration

    public Annot GetParent()

##### Returns

Type | Description
--- | ---
Annot | An annot object which is the parent annotation of the Popup annotation.

##### Remarks

This annotation object represents the parent annotation with which this pop-up annotation shall be associated. If this entry is present, the parent annotation’s Contents, M, C, and Tentries shall override those of the pop-up annotation itself.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### IsOpen()

Gets the initial openning condition of Popup.

##### Declaration

    public bool IsOpen()

##### Returns

Type | Description
--- | ---
bool | A bool indicating whether the Popup is initially open.

##### Remarks

This Open option is a flag specifying whether the pop-up annotation shall initially be displayed open. Default value: false (closed). If this entry is present, the parent annotation’s Contents, M, C, and Tentries shall override those of the pop-up annotation itself.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### SetOpen(bool)

Sets the initial openning condition of Popup. (Optional)

##### Declaration

    public void SetOpen(bool is_open)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | is_open | A bool indicating whether the Popup is initially open.

##### Remarks

This Open option is a flag specifying whether the pop-up annotation shall initially be displayed open. Default value: false (closed). If this entry is present, the parent annotation’s Contents, M, C, and Tentries shall override those of the pop-up annotation itself.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

#### SetParent(Annot)

Sets the Parent annotation of the Popup annotation. (Optional)

##### Declaration

    public void SetParent(Annot parent)

##### Parameters

Type | Name | Description
--- | --- | ---
Annot | parent | An annot object which is the parent annotation of the Popup annotation.

##### Remarks

This annotation object represents the parent annotation with which this pop-up annotation shall be associated. If this entry is present, the parent annotation’s Contents, M, C, and Tentries shall override those of the pop-up annotation itself.

##### Exceptions

Type | Condition
--- | ---
PDFNetException | PDFNetException the PDFNet exception

### Implements

IDisposable