RowFormOptions

Options related to Dynamic Row Forms in AdapTable

export interface

Properties

Property Details

autoHandle

Whether AdapTable automatically updates AG Grid data model with created/edited/deleted rows

autoHandle?: boolean;

Default Value

true

Property Value

boolean

disableInlineEditing

Prevents direct editing in Grid cells even for editable columns

disableInlineEditing?: boolean;

Default Value

false

Property Value

boolean

includeColumnInRowForm

Is given Column displayed in Row Form

includeColumnInRowForm?: (rowFormColumnContext: RowFormColumnContext) => boolean;

Default Value

true

Property Value

(rowFormColumnContext:RowFormColumnContext) => boolean

onRowFormSubmit

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

onRowFormSubmit?: (rowFormSubmittedInfo: RowFormSubmittedInfo<TData>) => void;

Default Value

undefined

Property Value

(rowFormSubmittedInfo:RowFormSubmittedInfo<TData>) => void

rowFormButtons

Custom form buttons; if provided, need to handle form submission explicitly

rowFormButtons?: AdaptableButton<RowFormContext<TData>>[];

Property Value

AdaptableButton<RowFormContext<TData>>[]

rowFormDescription

Custom form description provider

rowFormDescription?: string | ((context: RowFormTitleContext<TData>) => string);

Default Value

undefined

Property Value

string | ((context:RowFormTitleContext<TData>) => string)

rowFormField

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

rowFormField?: (context: RowFormFieldContext<TData>) => Partial<AdaptableFormField> | undefined;

Default Value

undefined

Property Value

(context:RowFormFieldContext<TData>) => Partial<AdaptableFormField> | undefined

rowFormFieldLabel

Custom form field label provider.

Superseded by (which can return any subset of properties, including label); kept for backward compatibility.

rowFormFieldLabel?: (context: RowFormFieldContext<TData>) => string;

Default Value

undefined

Property Value

(context:RowFormFieldContext<TData>) => string

rowFormTitle

Custom form title provider

rowFormTitle?: string | ((context: RowFormTitleContext<TData>) => string);

Default Value

'Create New Row'/'Edit Row'

Property Value

string | ((context:RowFormTitleContext<TData>) => string)

setPrimaryKeyValue

Function called when auto-handling 'create' or 'clone' Command Button; returned value should be valid for Primary Key column

setPrimaryKeyValue?: (context: SetPrimaryKeyValueContext<TData>) => any;

Default Value

undefined

Property Value

(context:SetPrimaryKeyValueContext<TData>) => any