# Row Forms Technical Reference Canonical page: https://www.adaptabletools.com/docs/technical-reference-row-form ## Row Form Options | Property | Type | Description | Default | | --- | --- | --- | --- | | [autoHandle](https://www.adaptabletools.com/docs/reference/rowformoptions.md#autohandle) | `boolean` | Whether AdapTable automatically updates AG Grid data model with created/edited/deleted rows | true | | [disableInlineEditing](https://www.adaptabletools.com/docs/reference/rowformoptions.md#disableinlineediting) | `boolean` | Prevents direct editing in Grid cells even for editable columns | false | | [includeColumnInRowForm](https://www.adaptabletools.com/docs/reference/rowformoptions.md#includecolumninrowform) | `(rowFormColumnContext: `[`RowFormColumnContext`](https://www.adaptabletools.com/docs/reference/rowformcolumncontext.md)`) => boolean` | Is given Column displayed in Row Form | true | | [onRowFormSubmit](https://www.adaptabletools.com/docs/reference/rowformoptions.md#onrowformsubmit) | `(rowFormSubmittedInfo: `[`RowFormSubmittedInfo`](https://www.adaptabletools.com/docs/reference/rowformsubmittedinfo.md)`) => void` | Event fired when a Row Form is submitted via a standard button provided by AdapTable; this is not invoked when custom form buttons are provided | undefined | | [rowFormButtons](https://www.adaptabletools.com/docs/reference/rowformoptions.md#rowformbuttons) | [`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`<`[`RowFormContext`](https://www.adaptabletools.com/docs/reference/rowformcontext.md)`>[]` | Custom form buttons; if provided, need to handle form submission explicitly | | | [rowFormDescription](https://www.adaptabletools.com/docs/reference/rowformoptions.md#rowformdescription) | `string \| ((context: `[`RowFormTitleContext`](https://www.adaptabletools.com/docs/reference/rowformtitlecontext.md)`) => string)` | Custom form description provider | undefined | | [rowFormField](https://www.adaptabletools.com/docs/reference/rowformoptions.md#rowformfield) | `(context: `[`RowFormFieldContext`](https://www.adaptabletools.com/docs/reference/rowformfieldcontext.md)`) => Partial<`[`AdaptableFormField`](https://www.adaptabletools.com/docs/reference/adaptableformfield.md)`> \| undefined` | Per-column override for the auto-built .

Return any subset of `AdaptableFormField` properties to customise the
field for a particular column. Anything you don't return falls back to
AdapTable's default - which is derived from the column's data type
(string → `text`, number → `number`, boolean → `checkbox`, date →
`date`, columns with discrete options → `select`).

Returning `undefined` keeps the default field for that column.

Use this to unlock the full power of in
Row Forms - including:
- presentation (`placeholder`, `helpText`, `tooltip`)
- validation (`required`, `min`, `max`, `pattern`, `validate`)
- data-driven `hidden` / `disabled`
- alternative field types (`textarea`, `radio`, `slider`, `time`,
`datetime`, `color`)
- multi-select via `multi: true`
- bespoke widgets via `fieldType: 'custom'` + `render` | undefined | | [rowFormFieldLabel](https://www.adaptabletools.com/docs/reference/rowformoptions.md#rowformfieldlabel) | `(context: `[`RowFormFieldContext`](https://www.adaptabletools.com/docs/reference/rowformfieldcontext.md)`) => string` | Custom form field label provider.

Superseded by (which can return any subset of
properties, including `label`); kept for
backward compatibility. | undefined | | [rowFormTitle](https://www.adaptabletools.com/docs/reference/rowformoptions.md#rowformtitle) | `string \| ((context: `[`RowFormTitleContext`](https://www.adaptabletools.com/docs/reference/rowformtitlecontext.md)`) => string)` | Custom form title provider | 'Create New Row'/'Edit Row' | | [setPrimaryKeyValue](https://www.adaptabletools.com/docs/reference/rowformoptions.md#setprimarykeyvalue) | `(context: `[`SetPrimaryKeyValueContext`](https://www.adaptabletools.com/docs/reference/setprimarykeyvaluecontext.md)`) => any` | Function called when auto-handling 'create' or 'clone' Command Button; returned value should be valid for Primary Key column | undefined | `includeColumnInRowForm` receives a [`RowFormColumnContext`](https://www.adaptabletools.com/docs/reference/rowformcolumncontext.md): | Property | Type | Description | | --- | --- | --- | | [adaptableColumn](https://www.adaptabletools.com/docs/reference/rowformcolumncontext.md#adaptablecolumn) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md) | Column to be displayed | | [rowFormType](https://www.adaptabletools.com/docs/reference/rowformcolumncontext.md#rowformtype) | [`RowFormType`](https://www.adaptabletools.com/docs/reference/rowformtype.md) | Type of Row Form | | [adaptableContext](https://www.adaptabletools.com/docs/reference/rowformcolumncontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` | `rowFormButtons` is a list of [`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md) objects. The click handler receives a [`RowFormContext`](https://www.adaptabletools.com/docs/reference/rowformcontext.md), which is a create or edit context: | Property | Type | Description | Default | | --- | --- | --- | --- | | [buttonStyle](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#buttonstyle) | [`ButtonStyle`](https://www.adaptabletools.com/docs/reference/buttonstyle.md)` \| ((button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => `[`ButtonStyle`](https://www.adaptabletools.com/docs/reference/buttonstyle.md)`)` | Style for Button - can be object or function that provides a `ButtonStyle` object | | | [disabled](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#disabled) | `(button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => boolean` | Function that disables / enables the button based on its evaluation result | | | [hidden](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#hidden) | `(button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => boolean` | Function which sets whether Button is hidden | | | [icon](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#icon) | [`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md)` \| ((button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => `[`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md)`)` | Icon for Button - can be object or function that provides a `AdaptableIcon` object | | | [iconPosition](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#iconposition) | `'start' \| 'end'` | Where the icon appears relative to the label | 'start' | | [label](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#label) | `string \| ((button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => string)` | Label for Button - can be string or function that provides string | | | [onClick](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#onclick) | `(button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => void` | Function to invoke when button is clicked | | | [tooltip](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#tooltip) | `string \| ((button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => string)` | Tooltip for Button - can be string or function that provides string | | `buttonStyle` is a [`ButtonStyle`](https://www.adaptabletools.com/docs/reference/buttonstyle.md): | Property | Type | Description | Default | | --- | --- | --- | --- | | [className](https://www.adaptabletools.com/docs/reference/buttonstyle.md#classname) | `string` | CSS Classname to use for the Button | | | [tone](https://www.adaptabletools.com/docs/reference/buttonstyle.md#tone) | `'success' \| 'error' \| 'neutral' \| 'none' \| 'warning' \| 'info' \| 'accent'` | Button's Tone - values: 'success', 'error', 'neutral', 'none', 'warning', 'info', 'accent' | 'neutral' | | [variant](https://www.adaptabletools.com/docs/reference/buttonstyle.md#variant) | `'text' \| 'outlined' \| 'raised'` | How Button appears - values: 'text', 'outlined', 'raised' | 'outlined' | | Property | Type | Description | | --- | --- | --- | | [clonedRowNode](https://www.adaptabletools.com/docs/reference/createrowformcontext.md#clonedrownode) | `IRowNode` | The RowNode being cloned | | [type](https://www.adaptabletools.com/docs/reference/createrowformcontext.md#type) | `Extract<`[`RowFormType`](https://www.adaptabletools.com/docs/reference/rowformtype.md)`, 'rowCreated'>` | Type of the Context | | [adaptableContext](https://www.adaptabletools.com/docs/reference/createrowformcontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` | | Property | Type | Description | | --- | --- | --- | | [rowNode](https://www.adaptabletools.com/docs/reference/editrowformcontext.md#rownode) | `IRowNode` | The RowNode being edited | | [type](https://www.adaptabletools.com/docs/reference/editrowformcontext.md#type) | `Extract<`[`RowFormType`](https://www.adaptabletools.com/docs/reference/rowformtype.md)`, 'rowEdited'>` | Type of the Context | | [adaptableContext](https://www.adaptabletools.com/docs/reference/editrowformcontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` | `rowFormField` receives a [`RowFormFieldContext`](https://www.adaptabletools.com/docs/reference/rowformfieldcontext.md) and returns an [`AdaptableFormField`](https://www.adaptabletools.com/docs/reference/adaptableformfield.md): | Property | Type | Description | | --- | --- | --- | | [column](https://www.adaptabletools.com/docs/reference/rowformfieldcontext.md#column) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`` | Column the field is being built for. Return a partial field to override the default for this column only. | | [adaptableContext](https://www.adaptabletools.com/docs/reference/rowformfieldcontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` | Defines the form. `fields` is a list of fields, rows of fields, or field groups. `buttons` are the form buttons. `layout` is `rows` (the default) or `inline`. | Property | Type | Description | Default | | --- | --- | --- | --- | | [buttons](https://www.adaptabletools.com/docs/reference/adaptableform.md#buttons) | [`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`[]` | Buttons to include in the Form | | | [description](https://www.adaptabletools.com/docs/reference/adaptableform.md#description) | `string` | Additional information to appear in the Form | | | [fields](https://www.adaptabletools.com/docs/reference/adaptableform.md#fields) | `(`[`AdaptableFormField`](https://www.adaptabletools.com/docs/reference/adaptableformfield.md)` \| `[`AdaptableFormField`](https://www.adaptabletools.com/docs/reference/adaptableformfield.md)`[] \| `[`AdaptableFormFieldGroup`](https://www.adaptabletools.com/docs/reference/adaptableformfieldgroup.md)`)[]` | Collection of Dynamic Fields and Field Groups to display.

Items can be:
- a single (rendered on its own row in the
default `rows` layout, or as one cell in the `inline` layout),
- an array of (rendered side-by-side on the
same row in the `rows` layout), or
- an (a labelled section that
visually groups related fields). | | | [layout](https://www.adaptabletools.com/docs/reference/adaptableform.md#layout) | [`AdaptableFormLayout`](https://www.adaptabletools.com/docs/reference/adaptableformlayout.md) | How the form's fields are arranged on screen.

- `rows` (default): each field on its own row, label on the left and
input on the right. Suitable for popups / wizards.
- `inline`: fields are placed side-by-side on a single horizontal line,
with the label rendered immediately before its input. Designed for
compact contexts such as Dashboard Custom Toolbars where vertical
real-estate is scarce. | 'rows' | | [onSubmit](https://www.adaptabletools.com/docs/reference/adaptableform.md#onsubmit) | `(formData: TData, context: T) => void` | Optional form-level submit hook.

Fired when the user presses `Enter` while focus is inside any field
input AND the form is currently valid. The full `formData` is passed
through, typed as `TData` if you've supplied a custom shape.

Use this as an ergonomic shortcut to avoid wiring an explicit "Submit"
button - or in addition to one, so power users can press Enter to
commit. If the form is invalid the hook is not invoked. | | | [title](https://www.adaptabletools.com/docs/reference/adaptableform.md#title) | `string` | Title to appear in the Form | | Each field is an : | Property | Type | Description | Default | | --- | --- | --- | --- | | [clearToDefault](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#cleartodefault) | `boolean` | For single `select` fields only. When the user clears the combobox,
whether to restore instead of leaving the field empty.

Defaults to `true` when `defaultValue` is set, otherwise `false`.
Set to `false` when an empty selection is a distinct state from the default. | | | [defaultValue](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#defaultvalue) | `string \| boolean \| number \| Array` | Field Default Value - can be of type string, boolean, number, or for
`select` fields with `multi: true` an array of those.

For single `select` fields, this is also the value restored when the user
clears the combobox (unless is `false`). | | | [disabled](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#disabled) | `boolean \| ((formData: `[`AdaptableFormData`](https://www.adaptabletools.com/docs/reference/adaptableformdata.md)`, context: `[`BaseContext`](https://www.adaptabletools.com/docs/reference/basecontext.md)`) => boolean)` | Disable the field's input. Either a boolean or a function evaluated
against the current form data. Disabled fields render but the user
cannot edit them. | | | [fieldType](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#fieldtype) | [`AdaptableFormFieldType`](https://www.adaptabletools.com/docs/reference/adaptableformfieldtype.md) | Field Type - dictates which UI control is rendered | | | [helpText](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#helptext) | `string` | Inline help text rendered immediately below the field's input. Useful
for short explanations such as "format: YYYY-MM-DD" or "min 3 chars". | | | [hidden](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#hidden) | `boolean \| ((formData: `[`AdaptableFormData`](https://www.adaptabletools.com/docs/reference/adaptableformdata.md)`, context: `[`BaseContext`](https://www.adaptabletools.com/docs/reference/basecontext.md)`) => boolean)` | Hide the field. Either a boolean or a function evaluated against the
current form data. Hidden fields are not rendered and are excluded from
validation. | | | [label](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#label) | `string` | Label to display in the Field | | | [max](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#max) | `number \| string` | Maximum allowed value. For `number` and `slider`: the highest accepted
number. For `date`, `time` and `datetime`: the latest allowed value in
ISO format. | | | [maxLength](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#maxlength) | `number` | Maximum length for `text` and `textarea` fields. | | | [min](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#min) | `number \| string` | Minimum allowed value. For `number` and `slider`: the lowest accepted
number. For `date`, `time` and `datetime`: the earliest allowed value
in ISO format (`YYYY-MM-DD` / `HH:mm` / `YYYY-MM-DDTHH:mm`). | | | [minLength](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#minlength) | `number` | Minimum length for `text` and `textarea` fields. | | | [multi](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#multi) | `boolean` | For `select` fields only. When `true` the field renders as a
multi-select combobox; the field's value is an array of selected
`option.value`s rather than a single value. | false | | [name](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#name) | `string` | Name of the Field | | | [onValueChange](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#onvaluechange) | `(value: any, context: `[`BaseContext`](https://www.adaptabletools.com/docs/reference/basecontext.md)`) => void` | Optional callback invoked whenever value of this field changes | | | [options](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#options) | [`AdaptableFormFieldOption`](https://www.adaptabletools.com/docs/reference/adaptableformfieldoption.md)`[] \| ((formData: `[`AdaptableFormData`](https://www.adaptabletools.com/docs/reference/adaptableformdata.md)`, context: `[`BaseContext`](https://www.adaptabletools.com/docs/reference/basecontext.md)`) => `[`AdaptableFormFieldOption`](https://www.adaptabletools.com/docs/reference/adaptableformfieldoption.md)`[] \| Promise<`[`AdaptableFormFieldOption`](https://www.adaptabletools.com/docs/reference/adaptableformfieldoption.md)`[]>)` | Items to populate the `select` and `radio` fieldTypes.

Either a static array, or a function that derives the options from the
current form data and Adaptable context. The function form may return
a Promise for asynchronously-loaded options - the form will render the
field with no items until the promise resolves. | | | [pattern](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#pattern) | `string` | Regular expression that the value of a `text` field must match. | | | [placeholder](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#placeholder) | `string` | Placeholder text shown inside `text`, `textarea`, `number`, `date`,
`time` and `datetime` inputs when empty. For `select` fields it is
rendered as the empty-state label when no value is selected.

When omitted on a `select` field with a , the label of
the matching `options` entry is used as the empty-state label. | | | [render](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#render) | `(params: `[`AdaptableFormFieldRenderParams`](https://www.adaptabletools.com/docs/reference/adaptableformfieldrenderparams.md)`) => React.ReactNode` | For `custom` fields only. Renders an arbitrary React node as the
field's input. Receives the current value, a `setValue` setter
(controlled), the current form data, the Adaptable context and the
resolved `disabled` state.

Use this as an escape hatch when none of the built-in `fieldType`s
fit - e.g. to render a star-rating widget, a tag editor or any
bespoke control. | | | [required](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#required) | `boolean` | If `true` the field is treated as required. An empty value (`''`,
`null`, `undefined`, or unchecked checkbox) will produce a validation
error. | | | [rows](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#rows) | `number` | For `textarea` fields: the visible number of text rows. | 3 | | [step](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#step) | `number` | Stepping interval for `number`, `slider`, `time` and `datetime`
fields. | | | [tooltip](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#tooltip) | `string` | Tooltip shown when hovering the field's label. | | | [validate](https://www.adaptabletools.com/docs/reference/adaptableformfield.md#validate) | `(value: any, formData: `[`AdaptableFormData`](https://www.adaptabletools.com/docs/reference/adaptableformdata.md)`, context: `[`BaseContext`](https://www.adaptabletools.com/docs/reference/basecontext.md)`) => string \| null \| undefined` | Custom field-level validation. Return an error message string to mark
the field invalid, or `null`/`undefined` if the value is valid.

Custom validation runs *after* built-in checks (`required`, `min`,
`max`, `pattern`, etc.) - the first failing check wins. | | `fieldType` is an : [See API: adaptableformfieldtype](https://www.adaptabletools.com/docs/reference/adaptableformfieldtype.md) Select and radio `options` are objects: | Property | Type | Description | | --- | --- | --- | | [label](https://www.adaptabletools.com/docs/reference/adaptableformfieldoption.md#label) | `string` | Text shown for this choice. | | [value](https://www.adaptabletools.com/docs/reference/adaptableformfieldoption.md#value) | `any` | Value written into the form data when this choice is selected. | `layout` is an : [See API: adaptableformlayout](https://www.adaptabletools.com/docs/reference/adaptableformlayout.md) `buttons` are objects: | Property | Type | Description | Default | | --- | --- | --- | --- | | [buttonStyle](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#buttonstyle) | [`ButtonStyle`](https://www.adaptabletools.com/docs/reference/buttonstyle.md)` \| ((button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => `[`ButtonStyle`](https://www.adaptabletools.com/docs/reference/buttonstyle.md)`)` | Style for Button - can be object or function that provides a `ButtonStyle` object | | | [disabled](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#disabled) | `(button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => boolean` | Function that disables / enables the button based on its evaluation result | | | [hidden](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#hidden) | `(button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => boolean` | Function which sets whether Button is hidden | | | [icon](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#icon) | [`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md)` \| ((button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => `[`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md)`)` | Icon for Button - can be object or function that provides a `AdaptableIcon` object | | | [iconPosition](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#iconposition) | `'start' \| 'end'` | Where the icon appears relative to the label | 'start' | | [label](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#label) | `string \| ((button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => string)` | Label for Button - can be string or function that provides string | | | [onClick](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#onclick) | `(button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => void` | Function to invoke when button is clicked | | | [tooltip](https://www.adaptabletools.com/docs/reference/adaptablebutton.md#tooltip) | `string \| ((button: `[`AdaptableButton`](https://www.adaptabletools.com/docs/reference/adaptablebutton.md)`, context: CONTEXT_TYPE) => string)` | Tooltip for Button - can be string or function that provides string | | `buttonStyle` is a : | Property | Type | Description | Default | | --- | --- | --- | --- | | [className](https://www.adaptabletools.com/docs/reference/buttonstyle.md#classname) | `string` | CSS Classname to use for the Button | | | [tone](https://www.adaptabletools.com/docs/reference/buttonstyle.md#tone) | `'success' \| 'error' \| 'neutral' \| 'none' \| 'warning' \| 'info' \| 'accent'` | Button's Tone - values: 'success', 'error', 'neutral', 'none', 'warning', 'info', 'accent' | 'neutral' | | [variant](https://www.adaptabletools.com/docs/reference/buttonstyle.md#variant) | `'text' \| 'outlined' \| 'raised'` | How Button appears - values: 'text', 'outlined', 'raised' | 'outlined' | `setPrimaryKeyValue` receives a [`SetPrimaryKeyValueContext`](https://www.adaptabletools.com/docs/reference/setprimarykeyvaluecontext.md): | Property | Type | Description | | --- | --- | --- | | [rowData](https://www.adaptabletools.com/docs/reference/setprimarykeyvaluecontext.md#rowdata) | `TData` | Data in the row being created or cloned | | [adaptableContext](https://www.adaptabletools.com/docs/reference/setprimarykeyvaluecontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` | ----------- ## Row Form Submitted Event AdapTable fires the Row Form Submitted Event when an `edit` or `create` Row Form is submitted (or a `delete` ActionRowButton is clicked). This allows developers to handle the form submission themselves, and provide any additional actions, validation or messages to backend services as required. AdapTable handles all row manipulation directly, bypassing this event, if `autoHandle` is set to *true* in Row Form Options ### RowFormSubmittedInfo The [`RowFormSubmittedInfo`](https://www.adaptabletools.com/docs/reference/rowformsubmittedinfo.md) object can be one of 3 types: - a [`CreatedRowInfo`](https://www.adaptabletools.com/docs/reference/createdrowinfo.md) - which is defined as follows | Property | Type | Description | | --- | --- | --- | | [formData](https://www.adaptabletools.com/docs/reference/createdrowinfo.md#formdata) | [`AdaptableFormData`](https://www.adaptabletools.com/docs/reference/adaptableformdata.md) | Values entered in the form. Empty strings are omitted. | | [rowNode](https://www.adaptabletools.com/docs/reference/createdrowinfo.md#rownode) | `IRowNode` | Not set for a created row. The row does not exist yet; it is added from `formData` after this event. | | [type](https://www.adaptabletools.com/docs/reference/createdrowinfo.md#type) | `'rowCreated'` | Always `rowCreated`. | | [adaptableContext](https://www.adaptabletools.com/docs/reference/createdrowinfo.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` | - an [`EditedRowInfo`](https://www.adaptabletools.com/docs/reference/editedrowinfo.md) - which is defined as follows | Property | Type | Description | | --- | --- | --- | | [formData](https://www.adaptabletools.com/docs/reference/editedrowinfo.md#formdata) | [`AdaptableFormData`](https://www.adaptabletools.com/docs/reference/adaptableformdata.md) | Values entered in the form. | | [rowNode](https://www.adaptabletools.com/docs/reference/editedrowinfo.md#rownode) | `IRowNode` | Row being edited. It is still the row in the grid when this event fires. | | [type](https://www.adaptabletools.com/docs/reference/editedrowinfo.md#type) | `'rowEdited'` | Always `rowEdited`. | | [adaptableContext](https://www.adaptabletools.com/docs/reference/editedrowinfo.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` | - a [`DeletedRowInfo`](https://www.adaptabletools.com/docs/reference/deletedrowinfo.md) - which is defined as follows | Property | Type | Description | | --- | --- | --- | | [rowNode](https://www.adaptabletools.com/docs/reference/deletedrowinfo.md#rownode) | `IRowNode` | Row about to be deleted. It is still in the grid when this event fires. | | [type](https://www.adaptabletools.com/docs/reference/deletedrowinfo.md#type) | `'rowDeleted'` | Always `rowDeleted`. | | [adaptableContext](https://www.adaptabletools.com/docs/reference/deletedrowinfo.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` | ### Event Subscription Subscribing to the Event is done the same way as with all [Adaptable Events](https://www.adaptabletools.com/docs/technical-reference-adaptable-events/index.md): ```ts api.eventApi.on('RowFormSubmitted', (eventInfo: RowFormSubmittedInfo) => { // do something with the info }); ``` ----------- ## Row Form API | Method | Returns | Description | | --- | --- | --- | | [displayCloneRowForm(primaryKey)](https://www.adaptabletools.com/docs/reference/rowformapi.md#displayclonerowform) | `Promise` | Opens the Row Form to create a row, prefilled from an existing row. | | [displayCreateRowForm()](https://www.adaptabletools.com/docs/reference/rowformapi.md#displaycreaterowform) | `Promise` | Open create dialog for a new row | | [displayDeleteRowForm(primaryKey)](https://www.adaptabletools.com/docs/reference/rowformapi.md#displaydeleterowform) | `void` | Deletes a row and fires the Row Form submitted event. No form is shown. | | [displayEditRowForm(primaryKey)](https://www.adaptabletools.com/docs/reference/rowformapi.md#displayeditrowform) | `Promise` | Opens the Row Form to edit the row with this primary key. |