Interface IListFormDisplayProps

List Form Display Properties

Hierarchy

Properties

assignTo? className? displayAttachments? el? excludeFields? groupClassName? includeFields? info onControlRendered? onControlRendering? onError? onFormRendered? onGetFields? rowClassName? template?

Properties

Optional assignTo

assignTo?: ((obj) => void)

Type declaration

    • (obj): void

    • Assigns the object to the input parameter.

      Parameters

      Returns void

Optional className

className?: string

The form component class name.

Optional displayAttachments

displayAttachments?: boolean

Flag to display the attachments, if they are loaded.

Optional el

el?: HTMLElement

The element to render the form to.

Optional excludeFields

excludeFields?: string[]

The fields to exclude from the form.

Optional groupClassName

groupClassName?: string

The form component group class name.

Optional includeFields

includeFields?: string[]

The fields to include in the form.

info

info: IListFormResult

The list form information.

Optional onControlRendered

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

Type declaration

Optional onControlRendering

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

Type declaration

Optional onError

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

Type declaration

    • (msg?): void

    • The error event.

      Parameters

      • Optional msg: string

      Returns void

Optional onFormRendered

onFormRendered?: ((form) => void)

Type declaration

    • (form): void

    • The form rendered event.

      Parameters

      Returns void

Optional onGetFields

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

Type declaration

    • (fieldNames?): string[]

    • The fields to render event.

      Parameters

      • Optional fieldNames: string[]

      Returns string[]

Optional rowClassName

rowClassName?: string

The form component row class name.

Optional template

template?: IFormRow[]

The list form rows.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc