Interface IWPSearchEditForm

Search WebPart Edit Form

Hierarchy

IWPListEditForm<IWPSearchCfg, IWPSearchInfo>
- IWPSearchEditForm

Index

Properties

actions? listQuery? onListChanged? onListsLoaded? onRenderForm? onSave? showSaveButton?

Properties

`Optional` actions

actions?: IButtonProps[]

The form action buttons displayed in the footer of the modal.

`Optional` listQuery

listQuery?: IODataQuery

The odata list query.

`Optional` onListChanged

onListChanged?: ((wpInfo, list?) => void | IFormControlProps[] | PromiseLike<IFormControlProps[]>)

Type declaration

- (wpInfo, list?): void | IFormControlProps[] | PromiseLike<IFormControlProps[]>
- The list changed event.
  Parameters
  - wpInfo: IWPSearchInfo
  - Optional list: List | IListQuery
  Returns void | IFormControlProps[] | PromiseLike<IFormControlProps[]>

`Optional` onListsLoaded

onListsLoaded?: ((wpInfo, lists?) => (List | IListQuery)[])

Type declaration

- (wpInfo, lists?): (List | IListQuery)[]
- The lists loaded event.
  Parameters
  - wpInfo: IWPSearchInfo
  - Optional lists: (List | IListQuery)[]
  Returns (List | IListQuery)[]

`Optional` onRenderForm

onRenderForm?: ((wpInfo, list?) => void | IFormControlProps[] | PromiseLike<IFormControlProps[]>)

Type declaration

- (wpInfo, list?): void | IFormControlProps[] | PromiseLike<IFormControlProps[]>
- The render form event.
  Parameters
  - wpInfo: IWPSearchInfo
  - Optional list: List | IListQuery
  Returns void | IFormControlProps[] | PromiseLike<IFormControlProps[]>

`Optional` onSave

onSave?: ((wpCfg?, form?) => IWPSearchCfg)

Type declaration

- (wpCfg?, form?): IWPSearchCfg
- The save event.
  Parameters
  - Optional wpCfg: IWPSearchCfg
  - Optional form: IForm
  Returns IWPSearchCfg

`Optional` showSaveButton

showSaveButton?: boolean

True to hide the save button.

Generated using TypeDoc