---
title: PDFAnnotationKey
framework: pdfkit
role: symbol
role_heading: Structure
path: pdfkit/pdfannotationkey
---

# PDFAnnotationKey

Keys for setting properties of annotations.

## Declaration

```swift
struct PDFAnnotationKey
```

## Topics

### Configuring General Properties

- [contents](pdfkit/pdfannotationkey/contents.md)
- [date](pdfkit/pdfannotationkey/date.md)
- [flags](pdfkit/pdfannotationkey/flags.md)
- [name](pdfkit/pdfannotationkey/name.md)
- [page](pdfkit/pdfannotationkey/page.md)
- [parent](pdfkit/pdfannotationkey/parent.md)
- [quadPoints](pdfkit/pdfannotationkey/quadpoints.md)
- [rect](pdfkit/pdfannotationkey/rect.md)
- [subtype](pdfkit/pdfannotationkey/subtype.md)
- [textLabel](pdfkit/pdfannotationkey/textlabel.md)

### Configuring Annotation Appearance

- [appearanceDictionary](pdfkit/pdfannotationkey/appearancedictionary.md)
- [appearanceState](pdfkit/pdfannotationkey/appearancestate.md)
- [border](pdfkit/pdfannotationkey/border.md)
- [borderStyle](pdfkit/pdfannotationkey/borderstyle.md)
- [color](pdfkit/pdfannotationkey/color.md)
- [defaultAppearance](pdfkit/pdfannotationkey/defaultappearance.md)
- [highlightingMode](pdfkit/pdfannotationkey/highlightingmode.md)
- [PDFAnnotationHighlightingMode](pdfkit/pdfannotationhighlightingmode.md)
- [iconName](pdfkit/pdfannotationkey/iconname.md)
- [interiorColor](pdfkit/pdfannotationkey/interiorcolor.md)
- [quadding](pdfkit/pdfannotationkey/quadding.md)

### Configuring Line Properties

- [lineEndingStyles](pdfkit/pdfannotationkey/lineendingstyles.md)
- [PDFLineStyle](pdfkit/pdflinestyle.md)
- [linePoints](pdfkit/pdfannotationkey/linepoints.md)
- [PDFAnnotationLineEndingStyle](pdfkit/pdfannotationlineendingstyle.md)

### Configuring Pop-Up Annotations

- [popup](pdfkit/pdfannotationkey/popup.md)
- [open](pdfkit/pdfannotationkey/open.md)

### Configuring Widget Annotations

- [widgetAppearanceDictionary](pdfkit/pdfannotationkey/widgetappearancedictionary.md)
- [widgetBackgroundColor](pdfkit/pdfannotationkey/widgetbackgroundcolor.md)
- [widgetBorderColor](pdfkit/pdfannotationkey/widgetbordercolor.md)
- [widgetCaption](pdfkit/pdfannotationkey/widgetcaption.md)
- [widgetDefaultValue](pdfkit/pdfannotationkey/widgetdefaultvalue.md)
- [widgetDownCaption](pdfkit/pdfannotationkey/widgetdowncaption.md)
- [widgetFieldFlags](pdfkit/pdfannotationkey/widgetfieldflags.md)
- [widgetFieldType](pdfkit/pdfannotationkey/widgetfieldtype.md)
- [widgetMaxLen](pdfkit/pdfannotationkey/widgetmaxlen.md)
- [widgetOptions](pdfkit/pdfannotationkey/widgetoptions.md)
- [widgetRolloverCaption](pdfkit/pdfannotationkey/widgetrollovercaption.md)
- [widgetRotation](pdfkit/pdfannotationkey/widgetrotation.md)
- [widgetTextLabelUI](pdfkit/pdfannotationkey/widgettextlabelui.md)
- [widgetValue](pdfkit/pdfannotationkey/widgetvalue.md)
- [PDFAnnotationWidgetSubtype](pdfkit/pdfannotationwidgetsubtype.md)

### Configuring Actions

- [destination](pdfkit/pdfannotationkey/destination.md)
- [action](pdfkit/pdfannotationkey/action.md)
- [additionalActions](pdfkit/pdfannotationkey/additionalactions.md)

### Configuring Ink Annotations

- [inklist](pdfkit/pdfannotationkey/inklist.md)

### Creating an Annotation Key

- [init(rawValue:)](pdfkit/pdfannotationkey/init(rawvalue:).md)

## Relationships

### Conforms To

- [Equatable](swift/equatable.md)
- [Hashable](swift/hashable.md)
- [RawRepresentable](swift/rawrepresentable.md)
- [Sendable](swift/sendable.md)
- [SendableMetatype](swift/sendablemetatype.md)

## See Also

### Modifying Annotation Attributes

- [annotationKeyValues](pdfkit/pdfannotation/annotationkeyvalues.md)
- [value(forAnnotationKey:)](pdfkit/pdfannotation/value(forannotationkey:).md)
- [setValue(_:forAnnotationKey:)](pdfkit/pdfannotation/setvalue(_:forannotationkey:).md)
- [setBoolean(_:forAnnotationKey:)](pdfkit/pdfannotation/setboolean(_:forannotationkey:).md)
- [setRect(_:forAnnotationKey:)](pdfkit/pdfannotation/setrect(_:forannotationkey:).md)
- [removeValue(forAnnotationKey:)](pdfkit/pdfannotation/removevalue(forannotationkey:).md)