Popup Class

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 Hierarchy

SystemObject
pdftron.PDF.AnnotsPopup

Namespace: pdftron.PDF.Annots
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255

Syntax

C++

JavaScript

Copy

public sealed class Popup : IClosable, 
	IAnnot

Public NotInheritable Class Popup
	Implements IClosable, IAnnot

public ref class Popup sealed : IClosable, 
	IAnnot

pdftron.PDF.Annots.Popup = function();

Type.createClass(
	'pdftron.PDF.Annots.Popup',
	null,
	Windows.Foundation.IClosable,
	pdftron.PDF.IAnnot);

The Popup type exposes the following members.

Constructors

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

Top

Methods

	Name	Description
	Close
	Create	Creates a new Popup annotation, in the specified document.
	DeleteCustomData	Deletes custom data associated with the given key.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Flatten	Flatten/Merge the existing annotation appearances with the page content and delete this annotation from a given page. Annotation 'flattening' refers to the operation that changes active annotations (such as markup, widgets, 3D models, etc.) into a static area that is part of the PDF document, just like the other text and images in the document.
	GetAnnotType	Gets the type.
	GetAppearance	Gets the annotation’s appearance for the given combination of annotation and appearance states.
	GetAppearance(AnnotAnnotationState)	Gets the annotation’s appearance for the given combination of annotation and appearance states.
	GetAppearance(AnnotAnnotationState, String)	Gets the annotation’s appearance for the given combination of annotation and appearance states.
	GetBorderStyle	Gets the border style for the annotation. Typically used for Link annotations.
	GetColorAsCMYK	Gets an annotation's color.
	GetColorAsGray	Gets an annotation's color.
	GetColorAsRGB	Gets the annotation’s active appearance state.
	GetColorCompNum	Gets the color space the annotation's color is represented in.
	GetContents	Gets the contents.
	GetCustomData	Returns custom data associated with the given key.
	GetDate	Gets an annotation's last modified date.
	GetFlag	Gets the flag.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetOptionalContent	Gets optional content of an annotation.
	GetPage	Gets the page the annotation is associated with.
	GetParent	Gets the Parent annotation of the Popup annotation.
	GetRect	Gets the rect.
	GetRotation	Gets the rotation value of the annotation. The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90.
	GetSDFObj	Gets the SDFObj.
	GetStructParent	Gets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
	GetTriggerAction	Get the Action associated with the selected Annot Trigger event
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUniqueID	Gets the unique ID.
	IsMarkup	Checks if is markup.
	IsOpen	Gets the initial openning condition of Popup.
	IsValid	Checks if is valid.
	RefreshAppearance	Regenerates the appearance stream for the annotation. This method can be used to auto-generate the annotation appearance after creating or modifying the annotation without providing an explicit appearance or setting the "NeedAppearances" flag in the AcroForm dictionary.
	RefreshAppearance(RefreshOptions)	A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
	RemoveAppearance	Removes the annotation's appearance
	RemoveAppearance(AnnotAnnotationState)	Removes the annotation's appearance for the given combination of annotation and appearance states.
	RemoveAppearance(AnnotAnnotationState, String)	Removes the annotation's appearance for the given combination of annotation and appearance states.
	Resize	Resize.
	SetAppearance(Obj)	Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
	SetAppearance(Obj, AnnotAnnotationState)	Removes the annotation's appearance for the given combination of annotation and appearance states.
	SetAppearance(Obj, AnnotAnnotationState, String)	Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
	SetBorderStyle	Sets the border style for the annotation. Typically used for Link annotations.
	SetColor(ColorPt)	Sets an annotation's color. (Optional; PDF 1.1)
	SetColor(ColorPt, Int32)	Sets an annotation's color. (Optional; PDF 1.1)
	SetContents	Sets the contents.
	SetCustomData	Sets the custom data associated with the specified key.
	SetDate	Sets an annotation's last modified date.
	SetDateToNow	Sets an annotation's modification date and time to the current time. This corresponds to the value of the "M" field of annotation dictionary(PDF 1.1)
	SetFlag	Sets the value of given Flag.
	SetOpen	Sets the initial openning condition of Popup. (Optional)
	SetOptionalContent	Sets optional content of an annotation. (Optional, PDF1.5).
	SetPage	Sets the reference to a page the annotation is associated with. (Optional PDF 1.3; not used in FDF files)
	SetParent	Sets the Parent annotation of the Popup annotation. (Optional)
	SetRect	Sets the size and location of an annotation on its page.
	SetRotation	Sets the rotation value of the annotation. The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90. (Optional)
	SetStructParent	Sets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
	SetUniqueID	Sets the unique identifier for this annotation.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

pdftron.PDF.Annots Namespace