List Form Display Properties

Hierarchy

Properties

assignTo?: ((obj) => void)

Type declaration

    • (obj): void
    • Assigns the object to the input parameter.

      Parameters

      Returns void

className?: string

The form component class name.

displayAttachments?: boolean

Flag to display the attachments, if they are loaded.

el?: HTMLElement

The element to render the form to.

excludeFields?: string[]

The fields to exclude from the form.

groupClassName?: string

The form component group class name.

includeFields?: string[]

The fields to include in the form.

info: IListFormResult

The list form information.

onControlRendered?: ((control, field) => void | Promise<IFormControl>)

Type declaration

onControlRendering?: ((control, field) => void | Promise<IFormControlProps>)

Type declaration

onError?: ((msg?) => void)

Type declaration

    • (msg?): void
    • The error event.

      Parameters

      • Optional msg: string

      Returns void

onFormRendered?: ((form) => void)

Type declaration

    • (form): void
    • The form rendered event.

      Parameters

      Returns void

onGetFields?: ((fieldNames?) => string[])

Type declaration

    • (fieldNames?): string[]
    • The fields to render event.

      Parameters

      • Optional fieldNames: string[]

      Returns string[]

rowClassName?: string

The form component row class name.

template?: IFormRow[]

The list form rows.

Generated using TypeDoc