---
title: "PdfWidgetAnnotation"
canonical_url: "https://www.nutrient.io/api/python/editors/pdf/annotations/pdf-widget-annotation/"
md_url: "https://www.nutrient.io/api/python/editors/pdf/annotations/pdf-widget-annotation.md"
last_updated: "2026-06-09T10:32:42.528Z"
description: "Represents a widget annotation (form field)."
---

Represents a widget annotation (form field).

```python

from nutrient_sdk import PdfWidgetAnnotation

```

**Inherits from:** [`PdfAnnotation`](/api/python/editors/pdf/annotations/pdf-annotation/)

## Construction

`PdfWidgetAnnotation` cannot be instantiated directly. Obtain instances through static factory methods or via other SDK classes.

## Properties

### alternate_field_name

```python

@property
def alternate_field_name(self) -> str

```

The alternate field name for display.

**Type:** `str`

*Read-only property.*

---

### field_name

```python

@property
def field_name(self) -> str

```

The field name (partial name).

**Type:** `str`

*Read-only property.*

---

### field_type

```python

@property
def field_type(self) -> str

```

The field type (Tx, Btn, Ch, Sig).

**Type:** `str`

*Read-only property.*

---

### is_button

```python

@property
def is_button(self) -> bool

```

Whether this is a button (checkbox, radio button, or push button).

**Type:** `bool`

*Read-only property.*

---

### is_choice_field

```python

@property
def is_choice_field(self) -> bool

```

Whether this is a choice field (combo box or list box).

**Type:** `bool`

*Read-only property.*

---

### is_signature_field

```python

@property
def is_signature_field(self) -> bool

```

Whether this is a signature field.

**Type:** `bool`

*Read-only property.*

---

### is_text_field

```python

@property
def is_text_field(self) -> bool

```

Whether this is a text field.

**Type:** `bool`

*Read-only property.*

---

## Inherited members

From [`PdfAnnotation`](../pdf-annotation/): `blend_mode`, `border_effect`, `border_effect_intensity`, `border_style`, `border_width`, `color`, `contents`, `index`, `is_hidden`, `is_printable`, `modification_date`, `name`, `rect`, `sub_type`, `title`

---

## Related pages

- [All public classes import directly from the top-level package:](/api/python/editors/pdf/annotations.md)
- [Pdf Annotation](/api/python/editors/pdf/annotations/pdf-annotation.md)
- [Pdf Circle Annotation](/api/python/editors/pdf/annotations/pdf-circle-annotation.md)
- [Pdf Annotation Collection](/api/python/editors/pdf/annotations/pdf-annotation-collection.md)
- [Pdf Highlight Annotation](/api/python/editors/pdf/annotations/pdf-highlight-annotation.md)
- [Pdf Line Annotation](/api/python/editors/pdf/annotations/pdf-line-annotation.md)
- [Pdf Markup Annotation](/api/python/editors/pdf/annotations/pdf-markup-annotation.md)
- [Pdf Link Annotation](/api/python/editors/pdf/annotations/pdf-link-annotation.md)
- [Pdf Shape Annotation](/api/python/editors/pdf/annotations/pdf-shape-annotation.md)
- [Pdf Redact Annotation](/api/python/editors/pdf/annotations/pdf-redact-annotation.md)
- [Pdf Free Text Annotation](/api/python/editors/pdf/annotations/pdf-free-text-annotation.md)
- [Pdf Square Annotation](/api/python/editors/pdf/annotations/pdf-square-annotation.md)
- [Pdf Squiggly Annotation](/api/python/editors/pdf/annotations/pdf-squiggly-annotation.md)
- [Pdf Stamp Annotation](/api/python/editors/pdf/annotations/pdf-stamp-annotation.md)
- [Pdf Strike Out Annotation](/api/python/editors/pdf/annotations/pdf-strike-out-annotation.md)
- [Pdf Underline Annotation](/api/python/editors/pdf/annotations/pdf-underline-annotation.md)
- [Pdf Text Annotation](/api/python/editors/pdf/annotations/pdf-text-annotation.md)