Interface IListForm

List Form

Hierarchy

IListForm
- IListForm

Index

Methods

create generateODataQuery loadAttachments refreshItem removeAttachment renderDisplayForm renderEditForm saveAttachments saveItem showFileDialog

Methods

create

create(props): PromiseLike<IListFormResult>
Creates an instance of the list form
Parameters
- props: IListFormProps
  
  The list form properties.
Returns PromiseLike<IListFormResult>
Inherited from Helper.IListForm.create
- Defined in node_modules/.pnpm/gd-sprest@7.8.8/node_modules/gd-sprest/@types/helper/listForm.d.ts:18

generateODataQuery

generateODataQuery(info, loadAttachments?): IODataQuery
Method to generate the odata query for the list item.
Parameters
- info: IListFormResult
- Optional loadAttachments: boolean
Returns IODataQuery
Inherited from Helper.IListForm.generateODataQuery
- Defined in node_modules/.pnpm/gd-sprest@7.8.8/node_modules/gd-sprest/@types/helper/listForm.d.ts:23

loadAttachments

loadAttachments(info): PromiseLike<Attachment[]>
Method to load the item attachments
Parameters
- info: IListFormProps
  
  The list form information.
Returns PromiseLike<Attachment[]>
Inherited from Helper.IListForm.loadAttachments
- Defined in node_modules/.pnpm/gd-sprest@7.8.8/node_modules/gd-sprest/@types/helper/listForm.d.ts:29

refreshItem

refreshItem(info): PromiseLike<IListFormResult>
Method to refresh the item.
Parameters
- info: IListFormResult
  
  The list form information.
Returns PromiseLike<IListFormResult>
Inherited from Helper.IListForm.refreshItem
- Defined in node_modules/.pnpm/gd-sprest@7.8.8/node_modules/gd-sprest/@types/helper/listForm.d.ts:35

removeAttachment

removeAttachment(info, fileName): PromiseLike<IListFormResult>
Method to remove attachment from an item.
Parameters
- info: IListFormResult
- fileName: string
Returns PromiseLike<IListFormResult>
Inherited from Helper.IListForm.removeAttachment
- Defined in node_modules/.pnpm/gd-sprest@7.8.8/node_modules/gd-sprest/@types/helper/listForm.d.ts:40

renderDisplayForm

renderDisplayForm(props): IListFormDisplay
Method to render the display form template.
Parameters
- props: IListFormDisplayProps
  
  The display form properties.
Returns IListFormDisplay
- Defined in src/components/listForm/types.d.ts:18

renderEditForm

renderEditForm(props): IListFormEdit
Method to render the edit/new form.
Parameters
- props: IListFormEditProps
  
  The edit/new form properties.
Returns IListFormEdit
- Defined in src/components/listForm/types.d.ts:24

saveAttachments

saveAttachments(info, attachmentInfo): PromiseLike<Attachment[]>
Method to save attachments to the item.
Parameters
- info: IListFormProps
  
  The list form information.
- attachmentInfo: IListFormAttachmentInfo[]
  
  The attachment files to add.
Returns PromiseLike<Attachment[]>
Inherited from Helper.IListForm.saveAttachments
- Defined in node_modules/.pnpm/gd-sprest@7.8.8/node_modules/gd-sprest/@types/helper/listForm.d.ts:47

saveItem

saveItem(info, formValues): PromiseLike<IListFormResult>
Method to save the item.
Parameters
- info: IListFormResult
  
  The list form information.
- formValues: any
Returns PromiseLike<IListFormResult>
Inherited from Helper.IListForm.saveItem
- Defined in node_modules/.pnpm/gd-sprest@7.8.8/node_modules/gd-sprest/@types/helper/listForm.d.ts:54

showFileDialog

showFileDialog(accept?): PromiseLike<IListFormAttachmentInfo>
Method to show the file dialog.
Parameters
- Optional accept: string[]
  
  The acceptable file extensions to allow.
Returns PromiseLike<IListFormAttachmentInfo>
Inherited from Helper.IListForm.showFileDialog
- Defined in node_modules/.pnpm/gd-sprest@7.8.8/node_modules/gd-sprest/@types/helper/listForm.d.ts:60
showFileDialog(accept?, info?, onSave?): PromiseLike<IListFormResult>
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>
Inherited from Helper.IListForm.showFileDialog
- Defined in node_modules/.pnpm/gd-sprest@7.8.8/node_modules/gd-sprest/@types/helper/listForm.d.ts:68

Interface IListForm

Hierarchy

Index

Methods

Methods

create

Parameters

props: IListFormProps

Returns PromiseLike<IListFormResult>

generateODataQuery

Parameters

info: IListFormResult

Optional loadAttachments: boolean

Returns IODataQuery

loadAttachments

Parameters

info: IListFormProps

Returns PromiseLike<Attachment[]>

refreshItem

Parameters

info: IListFormResult

Returns PromiseLike<IListFormResult>

removeAttachment

Parameters

info: IListFormResult

fileName: string

Returns PromiseLike<IListFormResult>

renderDisplayForm

Parameters

props: IListFormDisplayProps

Returns IListFormDisplay

renderEditForm

Parameters

props: IListFormEditProps

Returns IListFormEdit

saveAttachments

Parameters

info: IListFormProps

attachmentInfo: IListFormAttachmentInfo[]

Returns PromiseLike<Attachment[]>

saveItem

Parameters

info: IListFormResult

formValues: any

Returns PromiseLike<IListFormResult>

showFileDialog

Parameters

Optional accept: string[]

Returns PromiseLike<IListFormAttachmentInfo>

Parameters

Optional accept: string[]

Optional info: IListFormResult

Optional onSave: ((IListFormAttachmentInfo) => void)

Parameters

IListFormAttachmentInfo: any

Returns void

Returns PromiseLike<IListFormResult>

Settings

Member Visibility

Theme

On This Page

`Optional` loadAttachments: boolean

`Optional` accept: string[]

`Optional` accept: string[]

`Optional` info: IListFormResult

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