<!--
{
  "availability" : [
    "macOS: 10.4.0 - 10.12.0"
  ],
  "documentType" : "symbol",
  "framework" : "PDFKit",
  "identifier" : "/documentation/PDFKit/PDFAnnotationChoiceWidget",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "PDFKit"
    ],
    "preciseIdentifier" : "c:objc(cs)PDFAnnotationChoiceWidget"
  },
  "title" : "PDFAnnotationChoiceWidget"
}
-->

# PDFAnnotationChoiceWidget

A `PDFAnnotationChoiceWidget` object provides user interactivity on a page of a PDF document, in the form of pop-up menus and lists.

```
class PDFAnnotationChoiceWidget
```

## Overview

`PDFAnnotationChoiceWidget` inherits general annotation behavior from the `PDFAnnotation` class. If you use a `PDFAnnotationChoiceWidget` object, your application must handle hit testing, unless you are simply using `PDFView` to display content. This is because `PDFView` automatically handles hit testing for you.

## Topics

### Getting and Setting the String Value

[`-  stringValue`](/documentation/PDFKit/PDFAnnotationChoiceWidget/stringValue())

Returns the selection in the widget annotation.

[`-  setStringValue:`](/documentation/PDFKit/PDFAnnotationChoiceWidget/setStringValue(_:))

Sets the selection in the widget annotation.

### Managing Font and Background Color Characteristics

[`-  backgroundColor`](/documentation/PDFKit/PDFAnnotationChoiceWidget/backgroundColor())

Returns the color of the widget annotation background.

[`-  setBackgroundColor:`](/documentation/PDFKit/PDFAnnotationChoiceWidget/setBackgroundColor(_:))

Sets the background color of the widget annotation.

[`-  font`](/documentation/PDFKit/PDFAnnotationChoiceWidget/font())

Returns the font used to display the text in the widget annotation.

[`-  setFont:`](/documentation/PDFKit/PDFAnnotationChoiceWidget/setFont(_:))

Sets the font used to display the text in the widget annotation.

[`-  fontColor`](/documentation/PDFKit/PDFAnnotationChoiceWidget/fontColor())

Returns the font color used to display the text in the widget annotation.

[`-  setFontColor:`](/documentation/PDFKit/PDFAnnotationChoiceWidget/setFontColor(_:))

Sets the font color used to display the text in the widget annotation.

### Managing the Associated Field Name

[`-  fieldName`](/documentation/PDFKit/PDFAnnotationChoiceWidget/fieldName())

Returns the internal field name associated with the widget annotation.

[`-  setFieldName:`](/documentation/PDFKit/PDFAnnotationChoiceWidget/setFieldName(_:))

Sets the internal field name associated with the widget annotation’s value.

### Determining the Type of Choice Widget Annotation

[`-  isListChoice`](/documentation/PDFKit/PDFAnnotationChoiceWidget/isListChoice())

Returns a Boolean value indicating whether the widget annotation is a list.

[`-  setIsListChoice:`](/documentation/PDFKit/PDFAnnotationChoiceWidget/setIsListChoice(_:))

Sets whether the widget annotation is a list.

### Accessing the Items in the Choice Widget Annotation

[`-  choices`](/documentation/PDFKit/PDFAnnotationChoiceWidget/choices())

Returns an array of strings that represent the items available in the list or pop-up menu of the choice widget annotation.

[`-  setChoices:`](/documentation/PDFKit/PDFAnnotationChoiceWidget/setChoices(_:))

Sets the items available in the list or pop-up menu of the choice widget annotation.

## Relationships

### Conforms To

[`NSObjectProtocol`](/documentation/ObjectiveC/NSObjectProtocol)

[`CustomDebugStringConvertible`](/documentation/Swift/CustomDebugStringConvertible)

[`Equatable`](/documentation/Swift/Equatable)

[`NSCopying`](/documentation/Foundation/NSCopying)

[`CVarArg`](/documentation/Swift/CVarArg)

[`Hashable`](/documentation/Swift/Hashable)

[`NSCoding`](/documentation/Foundation/NSCoding)

[`CustomStringConvertible`](/documentation/Swift/CustomStringConvertible)

### Inherits From

[`PDFAnnotation`](/documentation/PDFKit/PDFAnnotation)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)