# FormEditInfo

Artifact: [androidx.pdf:pdf-core](https://developer.android.com/jetpack/androidx/releases/pdf) [View Source](https://cs.android.com/search?q=file:androidx/pdf/models/FormEditInfo.kt+class:androidx.pdf.models.FormEditInfo) Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

*** ** * ** ***


```
class FormEditInfo : Parcelable
```

<br />

*** ** * ** ***

Record of a form filling operation that has been executed on a single form field in a PDF. Contains the minimum amount of data required to replicate the action on the form.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/pdf/models/<` | [PDF 32000-1:2008]("https://opensource.adobe.com/dc-acrobat-sdk-docs/pdfstandards/PDF32000_2008.pdf") |

## Summary

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#EDIT_TYPE_CLICK() = 0` Indicates a click on a clickable form widget |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#EDIT_TYPE_SET_INDICES() = 1` Represents setting indices on a combobox or listbox form widget |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#EDIT_TYPE_SET_TEXT() = 2` Represents setting text on a text field or editable combobox form widget |

| ### Public companion functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#createClick(kotlin.Int,androidx.pdf.PdfPoint)(widgetIndex: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, clickPoint: https://developer.android.com/reference/kotlin/androidx/pdf/PdfPoint)` Create a FormEditInfo object of type `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#EDIT_TYPE_CLICK()` |
| `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#createSetIndices(kotlin.Int,kotlin.Int,kotlin.IntArray)( pageNumber: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, widgetIndex: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, selectedIndices: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int-array/index.html )` Create a FormEditInfo object of type `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#EDIT_TYPE_SET_INDICES()` |
| `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#createSetText(kotlin.Int,kotlin.Int,kotlin.String)( pageNumber: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, widgetIndex: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, text: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html )` Create a FormEditInfo object of type `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#EDIT_TYPE_SET_TEXT()` |

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/android/os/Parcelable.Creator.html<https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo>` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#CREATOR()` |

| ### Public functions |
|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#describeContents()()` |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#getSelectedIndexAt(kotlin.Int)(index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Returns the index of the selected item in the list `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormWidgetInfo#listItems()` at the given `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#getSelectedIndexAt(kotlin.Int)` in the list of selected indices. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#writeToParcel(android.os.Parcel,kotlin.Int)(dest: https://developer.android.com/reference/android/os/Parcel.html, flags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/pdf/PdfPoint?` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#clickPoint()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#pageNumber()` Represents the page number on which the edit occurred |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#selectedIndexCount()` Returns the count of the selected items. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#text()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#type()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#widgetIndex()` Represents the index of the widget that was edited. |

## Constants

### EDIT_TYPE_CLICK

```
const val EDIT_TYPE_CLICK = 0: Int
```

Indicates a click on a clickable form widget

### EDIT_TYPE_SET_INDICES

```
const val EDIT_TYPE_SET_INDICES = 1: Int
```

Represents setting indices on a combobox or listbox form widget

### EDIT_TYPE_SET_TEXT

```
const val EDIT_TYPE_SET_TEXT = 2: Int
```

Represents setting text on a text field or editable combobox form widget

## Public companion functions

### createClick

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
fun createClick(widgetIndex: @IntRange(from = 0) Int, clickPoint: PdfPoint): FormEditInfo
```

Create a FormEditInfo object of type `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#EDIT_TYPE_CLICK()`

| Parameters |
|---|---|
| `widgetIndex: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The index of the widget that was edited. |
| `clickPoint: https://developer.android.com/reference/kotlin/androidx/pdf/PdfPoint` | The point on the `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#pageNumber()` in PDF coordinates where the click occurred. Note: The origin exists at the top left corner of the page. |

### createSetIndices

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
fun createSetIndices(
    pageNumber: @IntRange(from = 0) Int,
    widgetIndex: @IntRange(from = 0) Int,
    selectedIndices: IntArray
): FormEditInfo
```

Create a FormEditInfo object of type `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#EDIT_TYPE_SET_INDICES()`

| Parameters |
|---|---|
| `pageNumber: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The page number on which the edit occurred. |
| `widgetIndex: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The index of the widget that was edited. |
| `selectedIndices: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int-array/index.html` | The indices of the selected items from `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormWidgetInfo#listItems()` |

### createSetText

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
fun createSetText(
    pageNumber: @IntRange(from = 0) Int,
    widgetIndex: @IntRange(from = 0) Int,
    text: String
): FormEditInfo
```

Create a FormEditInfo object of type `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#EDIT_TYPE_SET_TEXT()`

| Parameters |
|---|---|
| `pageNumber: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The page number on which the edit occurred. |
| `widgetIndex: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The index of the widget that was edited. |
| `text: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The text to set on the widget. |

## Public companion properties

### CREATOR

```
val CREATOR: Parcelable.Creator<FormEditInfo>
```

## Public functions

### describeContents

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
open fun describeContents(): Int
```

### equals

```
open operator fun equals(other: Any?): Boolean
```

### getSelectedIndexAt

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
fun getSelectedIndexAt(index: Int): Int
```

Returns the index of the selected item in the list `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormWidgetInfo#listItems()` at the given `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#getSelectedIndexAt(kotlin.Int)` in the list of selected indices.

| Parameters |
|---|---|
| `index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The position of the selected index to retrieve, from 0 to `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#selectedIndexCount()` - 1. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The index of the selected item from the list `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormWidgetInfo#listItems()`, returns -1 in case there is no selection or the index is invalid. |

### hashCode

```
open fun hashCode(): Int
```

### writeToParcel

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
open fun writeToParcel(dest: Parcel, flags: Int): Unit
```

## Public properties

### clickPoint

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
val clickPoint: PdfPoint?
```

### pageNumber

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
val pageNumber: Int
```

Represents the page number on which the edit occurred

### selectedIndexCount

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
val selectedIndexCount: Int
```

Returns the count of the selected items.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#createSetIndices(kotlin.Int,kotlin.Int,kotlin.IntArray)` | 'selectedIndices' in `https://developer.android.com/reference/kotlin/androidx/pdf/models/FormEditInfo#createSetIndices(kotlin.Int,kotlin.Int,kotlin.IntArray)`. |

### text

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
val text: String?
```

### type

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
val type: Int
```

Value is one of the following:

- `0`
- `1`
- `2`

<br />

### widgetIndex

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
val widgetIndex: Int
```

Represents the index of the widget that was edited.