Class PdfScreenAnnotation
public class PdfScreenAnnotation : PdfAnnotation- Inheritance
-
PdfScreenAnnotation
- Inherited Members
Constructors
PdfScreenAnnotation(Rectangle)
public PdfScreenAnnotation(Rectangle rect)Parameters
rectRectangle
PdfScreenAnnotation(PdfDictionary)
Instantiates a new PdfScreenAnnotation instance based on PdfDictionary instance, that represents existing annotation object in the document.
protected PdfScreenAnnotation(PdfDictionary pdfObject)Parameters
pdfObjectPdfDictionarythe PdfDictionary representing annotation object
- See Also
Methods
GetAction()
An PdfAction to perform, such as launching an application, playing a sound, changing an annotation’s appearance state etc, when the annotation is activated.
public virtual PdfDictionary GetAction()Returns
- PdfDictionary
PdfDictionary which defines the characteristics and behaviour of an action.
GetAdditionalAction()
An additional actions dictionary that extends the set of events that can trigger the execution of an action.
public virtual PdfDictionary GetAdditionalAction()Returns
- PdfDictionary
an additional actions PdfDictionary.
Remarks
An additional actions dictionary that extends the set of events that can trigger the execution of an action. See ISO-320001 12.6.3 Trigger Events.
- See Also
GetAppearanceCharacteristics()
An appearance characteristics dictionary containing additional information for constructing the annotation’s appearance stream.
public virtual PdfDictionary GetAppearanceCharacteristics()Returns
- PdfDictionary
an appearance characteristics dictionary or null if it isn't specified.
Remarks
An appearance characteristics dictionary containing additional information for constructing the annotation’s appearance stream. See ISO-320001, Table 189.
GetSubtype()
public override PdfName GetSubtype()Returns
SetAction(PdfAction)
Sets a PdfAction to this annotation which will be performed when the annotation is activated.
public virtual PdfScreenAnnotation SetAction(PdfAction action)Parameters
Returns
- PdfScreenAnnotation
this PdfScreenAnnotation instance.
SetAdditionalAction(PdfName, PdfAction)
Sets an additional
PdfAction
to this annotation which will be performed in response to
the specific trigger event defined by
key.
public virtual PdfScreenAnnotation SetAdditionalAction(PdfName key, PdfAction action)Parameters
keyPdfNamea PdfName that denotes a type of the additional action to set.
actionPdfActionPdfAction to set as additional to this annotation.
Returns
- PdfScreenAnnotation
this PdfScreenAnnotation instance.
Remarks
Sets an additional
PdfAction
to this annotation which will be performed in response to
the specific trigger event defined by
key
. See ISO-320001 12.6.3, "Trigger Events".
SetAppearanceCharacteristics(PdfDictionary)
Sets an appearance characteristics dictionary containing additional information for constructing the annotation’s appearance stream.
public virtual PdfScreenAnnotation SetAppearanceCharacteristics(PdfDictionary characteristics)Parameters
characteristicsPdfDictionarythe PdfDictionary with additional information for appearance stream.
Returns
- PdfScreenAnnotation
this PdfScreenAnnotation instance.
Remarks
Sets an appearance characteristics dictionary containing additional information for constructing the annotation’s appearance stream. See ISO-320001, Table 189.