PdfSharp-WPF  1.31.7289
PdfSharp.Pdf.Annotations Namespace Reference

Classes

class  PdfAnnotation
 Represents the base class of all annotations. More...
 
class  PdfAnnotations
 Represents the annotations array of a page. More...
 
class  PdfGenericAnnotation
 Represents a generic annotation. Used for annotation dictionaries unknown to PDFsharp.
 
class  PdfLinkAnnotation
 Represents a link annotation. More...
 
class  PdfRubberStampAnnotation
 Represents a rubber stamp annotation. More...
 
class  PdfTextAnnotation
 Represents a text annotation. More...
 
class  PdfWidgetAnnotation
 Represents a text annotation.
 

Enumerations

enum class  PdfAnnotationFlags {
  Invisible = 1 << (1 - 1) , Hidden = 1 << (2 - 1) , Print = 1 << (3 - 1) , NoZoom = 1 << (4 - 1) ,
  NoRotate = 1 << (5 - 1) , NoView = 1 << (6 - 1) , ReadOnly = 1 << (7 - 1) , Locked = 1 << (8 - 1) ,
  ToggleNoView = 1 << (9 - 1)
}
 Specifies the annotation flags. More...
 
enum class  PdfRubberStampAnnotationIcon {
  NoIcon , Approved , AsIs , Confidential ,
  Departmental , Draft , Experimental , Expired ,
  Final , ForComment , ForPublicRelease , NotApproved ,
  NotForPublicRelease , Sold , TopSecret
}
 Specifies the predefined icon names of rubber stamp annotations. More...
 
enum class  PdfTextAnnotationIcon {
  NoIcon , Comment , Help , Insert ,
  Key , NewParagraph , Note , Paragraph
}
 Specifies the pre-defined icon names of text annotations. More...
 

Enumeration Type Documentation

◆ PdfAnnotationFlags

Specifies the annotation flags.

Enumerator
Invisible 

If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an unknown annotation using an appearance stream specified by its appearancedictionary, if any.

Hidden 

(PDF 1.2) If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available. In cases where screen space is limited, the ability to hide and show annotations selectively can be used in combination with appearance streams to display auxiliary pop-up information similar in function to online help systems.

Print 

(PDF 1.2) If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. This can be useful, for example, for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.

NoZoom 

(PDF 1.3) If set, do not scale the annotation’s appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) remains fixed, regardless of the page magnification. See below for further discussion.

NoRotate 

(PDF 1.3) If set, do not rotate the annotation’s appearance to match the rotation of the page. The upper-left corner of the annotation rectangle remains in a fixed location on the page, regardless of the page rotation. See below for further discussion.

NoView 

(PDF 1.3) If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction.

ReadOnly 

(PDF 1.3) If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions. Note: This flag is ignored for widget annotations; its function is subsumed by the ReadOnly flag of the associated form field.

Locked 

(PDF 1.4) If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation’s contents, such as the value of a form field.

ToggleNoView 

(PDF 1.5) If set, invert the interpretation of the NoView flag for certain events. A typical use is to have an annotation that appears only when a mouse cursor is held over it.

◆ PdfRubberStampAnnotationIcon

Specifies the predefined icon names of rubber stamp annotations.

Enumerator
NoIcon 

A pre-defined rubber stamp annotation icon.

Approved 

A pre-defined rubber stamp annotation icon.

AsIs 

A pre-defined rubber stamp annotation icon.

Confidential 

A pre-defined rubber stamp annotation icon.

Departmental 

A pre-defined rubber stamp annotation icon.

Draft 

A pre-defined rubber stamp annotation icon.

Experimental 

A pre-defined rubber stamp annotation icon.

Expired 

A pre-defined rubber stamp annotation icon.

Final 

A pre-defined rubber stamp annotation icon.

ForComment 

A pre-defined rubber stamp annotation icon.

ForPublicRelease 

A pre-defined rubber stamp annotation icon.

NotApproved 

A pre-defined rubber stamp annotation icon.

NotForPublicRelease 

A pre-defined rubber stamp annotation icon.

Sold 

A pre-defined rubber stamp annotation icon.

TopSecret 

A pre-defined rubber stamp annotation icon.

◆ PdfTextAnnotationIcon

Specifies the pre-defined icon names of text annotations.

Enumerator
NoIcon 

A pre-defined annotation icon.

Comment 

A pre-defined annotation icon.

Help 

A pre-defined annotation icon.

Insert 

A pre-defined annotation icon.

Key 

A pre-defined annotation icon.

NewParagraph 

A pre-defined annotation icon.

Note 

A pre-defined annotation icon.

Paragraph 

A pre-defined annotation icon.