Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IListForm

List Form

Hierarchy

  • IListForm
    • IListForm

Index

Methods

Methods

create

  • create(props: IListFormProps): PromiseLike<IListFormResult>

  • Creates an instance of the list form

    Parameters

    • props: IListFormProps

      The list form properties.

    Returns PromiseLike<IListFormResult>

generateODataQuery

  • generateODataQuery(info: IListFormResult, loadAttachments?: boolean): IODataQuery

  • Method to generate the odata query for the list item.

    Parameters

    • info: IListFormResult
    • Optional loadAttachments: boolean

    Returns IODataQuery

loadAttachments

  • loadAttachments(info: IListFormProps): PromiseLike<Array<Attachment>>

  • Method to load the item attachments

    Parameters

    • info: IListFormProps

      The list form information.

    Returns PromiseLike<Array<Attachment>>

refreshItem

  • refreshItem(info: IListFormResult): PromiseLike<IListFormResult>

  • Method to refresh the item.

    Parameters

    • info: IListFormResult

      The list form information.

    Returns PromiseLike<IListFormResult>

removeAttachment

  • removeAttachment(info: IListFormResult, fileName: string): PromiseLike<IListFormResult>

  • Method to remove attachment from an item.

    Parameters

    • info: IListFormResult
    • fileName: string

    Returns PromiseLike<IListFormResult>

renderDisplayForm

  • Method to render the display form template.

    Parameters

    Returns IListFormDisplay

renderEditForm

  • Method to render the edit/new form.

    Parameters

    Returns IListFormEdit

saveAttachments

  • saveAttachments(info: IListFormProps, attachmentInfo: Array<IListFormAttachmentInfo>): PromiseLike<Array<Attachment>>

  • Method to save attachments to the item.

    Parameters

    • info: IListFormProps

      The list form information.

    • attachmentInfo: Array<IListFormAttachmentInfo>

      The attachment files to add.

    Returns PromiseLike<Array<Attachment>>

saveItem

  • saveItem(info: IListFormResult, formValues: any): PromiseLike<IListFormResult>

  • Method to save the item.

    Parameters

    • info: IListFormResult

      The list form information.

    • formValues: any

    Returns PromiseLike<IListFormResult>

showFileDialog

  • showFileDialog(): PromiseLike<IListFormAttachmentInfo>
  • showFileDialog(info: IListFormResult, onSave?: (IListFormAttachmentInfo: any) => void): PromiseLike<IListFormResult>

  • Method to show the file dialog.

    Returns PromiseLike<IListFormAttachmentInfo>

  • Method to show the file dialog.

    Parameters

    • info: IListFormResult

      The list form information.

    • Optional onSave: (IListFormAttachmentInfo: any) => void

      The save event triggered when a file is uploaded to the item.

        • (IListFormAttachmentInfo: any): void

        • Parameters

          • IListFormAttachmentInfo: any

          Returns void

    Returns PromiseLike<IListFormResult>

Generated using TypeDoc