Class PdfAnnotation.Keys
- Namespace
- PdfSharp.Pdf.Annotations
- Assembly
- PdfSharp.dll
Predefined keys of this dictionary.
public class PdfAnnotation.Keys : KeysBase
- Inheritance
-
objectPdfAnnotation.Keys
- Derived
Fields
- AF
(Optional; PDF 2.0) An array of one or more file specification dictionaries which denote the associated files for this annotation.
- AP
(Optional; PDF 1.2) An appearance dictionary specifying how the annotation shall be presented visually on the page. A PDF writer shall include an appearance dictionary when writing or updating the PDF file except for the two cases listed below. Every annotation(including those whose Subtype value is Widget, as used for form fields), except for the two cases listed below, shall have at least one appearance dictionary. • Annotations where the value of the Rect key consists of an array where the value at index 1 is equal to the value at index 3 and the value at index 2 is equal to the value at index 4. NOTE(2020) The bullet point above was changed from “or” to “and” in this document to match requirements in other published ISO PDF standards(such as PDF/A). • Annotations whose Subtype value is Popup, Projection or Link.
- AS
(Required if the appearance dictionary AP contains one or more subdictionaries; PDF 1.2) The annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary (see 12.5.5, "Appearance streams").
- BM
(Optional; PDF 2.0) The blend mode that shall be used when painting the annotation onto the page. If this key is not present, blending shall take place using the Normal blend mode. The value shall be a name object, designating one of the standard blend modes listed in "Table 134 — Standard separable blend modes" and "Table 135 — Standard non-separable blend modes".
- Border
(Optional) An array specifying the characteristics of the annotation’s border, which shall be drawn as a rounded rectangle. (PDF 1.0) The array consists of three numbers defining the horizontal corner radius, vertical corner radius, and border width, all in default user space units.If the corner radii are 0, the border has square(not rounded) corners; if the border width is 0, no border is drawn. (PDF 1.1) The array may have a fourth element, an optional dash array defining a pattern of dashes and gaps that shall be used in drawing the border.The dash array shall be specified in the same format as in the line dash pattern parameter of the graphics state(see 8.4.3.6, "Line dash pattern"). The dash phase shall not be specified and shall be assumed to be 0. EXAMPLE A Border value of[0 0 1[3 2]] specifies a border 1 unit wide, with square corners, drawn with 3-unit dashes alternating with 2- unit gaps. NOTE (PDF 1.2) The dictionaries for some annotation types (such as free text and polygon annotations) can include the BS entry.That entry specifies a border style dictionary that has more settings than the array specified for the Border entry.If an annotation dictionary includes the BS entry, then the Border entry is ignored. Default value: [0 0 1].
- C
(Optional; PDF 1.1) An array of numbers in the range 0.0 to 1.0, representing a colour used for the following purposes:
The background of the annotation’s icon when closed
The title bar of the annotation’s popup window
The border of a link annotation
The number of array elements determines the colour space in which the colour shall be defined:
0 No colour; transparent
1 DeviceGray
3 DeviceRGB
4 DeviceCMYK
- CA
(Optional; PDF 1.4, PDF 2.0 for non-markup annotations) When regenerating the annotation's appearance stream, this is the opacity value (11.2, "Overview of transparency") that shall be used for stroking all visible elements of the annotation in its closed state, including its background and border, but not the popup window that appears when the annotation is opened. If a ca entry is not present in this dictionary, then the value of this CA entry shall also be used for nonstroking operations as well. Default Value: 1.0 The specified value shall not be used if the annotation has an appearance stream; in that case, the appearance stream shall specify any transparency. If no explicit appearance stream is defined for the annotation, and the processor is not able to regenerate the appearance, the annotation may be painted by implementation-dependent means that do not necessarily conform to the PDF imaging model; in this case, the effect of this entry is implementation-dependent as well.
- Contents
(Optional) Text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternative description of the annotation’s contents in human-readable form. In either case, this text is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes. See PdfAnnotation types for more details on the meaning of this entry for each annotation type.
- F
(Optional; PDF 1.1) A set of flags specifying various characteristics of the annotation. Default value: 0.
- Lang
(Optional; PDF 2.0) A language identifier overriding the document’s language identifier to specify the natural language for all text in the annotation except where overridden by other explicit language specifications.
- M
(Optional; PDF 1.1) The date and time when the annotation was most recently modified. The format should be a date string.
- NM
(Optional; PDF 1.4) The annotation name, a text string uniquely identifying it among all the annotations on its page.
- OC
(Optional; PDF 1.5) An optional content group or optional content membership dictionary specifying the optional content properties for the annotation. Before the annotation is drawn, its visibility shall be determined based on this entry as well as the annotation flags specified in the F entry. If it is determined to be invisible, the annotation shall not be drawn.
- P
(Optional except as noted below; PDF 1.3; not used in FDF files) An indirect reference to the page object with which this annotation is associated. This entry shall be present in screen annotations associated with rendition actions.
- Rect
(Required) The annotation rectangle, defining the location of the annotation on the page in default user space units.
- StructParent
(Required if the annotation is a structural content item; PDF 1.3) The integer key of the annotation’s entry in the structural parent tree.
- Subtype
(Required) The type of annotation that this dictionary describes. See PdfAnnotationTypes.
- Type
(Optional) The type of PDF object that this dictionary describes; if present, shall be Annot for an annotation dictionary.
- ca
(Optional; PDF 2.0) When regenerating the annotation's appearance stream, this is the opacity value (11.2, "Overview of transparency") that shall be used for all nonstroking operations on all visible elements of the annotation in its closed state (including its background and border) but not the popup window that appears when the annotation is opened. Default value: 1.0 The specified value shall not be used if the annotation has an appearance stream; in that case, the appearance stream shall specify any transparency. If no explicit appearance stream is defined for the annotation, and the processor is not able to regenerate the appearance, the annotation may be painted by implementation-dependent means that do not necessarily conform to the PDF imaging