Interface IListForm

List Form

Hierarchy

  • IListForm
    • IListForm

Methods

create generateODataQuery loadAttachments refreshItem refreshRequestDigest removeAttachment renderDisplayForm renderEditForm saveAttachments saveItem showFileDialog

Methods

create

  • Creates an instance of the list form

    Parameters

    • props: IListFormProps

      The list form properties.

    Returns PromiseLike<IListFormResult>

generateODataQuery

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

    Parameters

    • info: IListFormResult
    • Optional loadAttachments: boolean

    Returns IODataQuery

loadAttachments

  • Method to load the item attachments

    Parameters

    • info: IListFormProps

      The list form information.

    Returns PromiseLike<Attachment[]>

refreshItem

  • Method to refresh the item.

    Parameters

    • info: IListFormResult

      The list form information.

    Returns PromiseLike<IListFormResult>

refreshRequestDigest

  • Method to refresh the request digest value.

    Parameters

    • info: IListFormResult

    Returns PromiseLike<void>

removeAttachment

  • Method to remove attachment from an item.

    Parameters

    • info: IListFormResult
    • fileName: string

    Returns PromiseLike<IListFormResult>

renderDisplayForm

renderEditForm

saveAttachments

  • Method to save attachments to the item.

    Parameters

    • info: IListFormProps

      The list form information.

    • attachmentInfo: IListFormAttachmentInfo[]

      The attachment files to add.

    Returns PromiseLike<Attachment[]>

saveItem

  • Method to save the item.

    Parameters

    • info: IListFormResult

      The list form information.

    • formValues: any
    • Optional checkItemVersion: boolean

    Returns PromiseLike<IListFormResult>

showFileDialog

  • Method to show the file dialog.

    Parameters

    • Optional accept: string[]

      The acceptable file extensions to allow.

    Returns PromiseLike<IListFormAttachmentInfo>

  • Method to show the file dialog.

    Parameters

    • Optional accept: string[]

      The acceptable file extensions to allow.

    • Optional info: IListFormResult

      The list form information.

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

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

        • (IListFormAttachmentInfo): void

        • Parameters

          • IListFormAttachmentInfo: any

          Returns void

    Returns PromiseLike<IListFormResult>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc