Interface IWPListProps<IListInfo, IListEditForm>

List WebPart Properties

Type Parameters

Hierarchy

Properties

camlQuery?: string

The caml query.

cfgElementId?: string

The optional configuration element

className?: string

The class name.

editForm?: IListEditForm

The edit form

elementId?: string

The target element id to render the webpart to

helpProps?: {
    title?: string;
    url: string;
}

The optional help link properties

Type declaration

  • Optional title?: string

    The link title

  • url: string

    The link url

odataQuery?: IODataQuery

The odata query.

onExecutingCAMLQuery?: ((wpInfo, caml) => string)

Type declaration

    • (wpInfo, caml): string
    • The executing caml query event.

      Parameters

      • wpInfo: IListInfo
      • caml: string

      Returns string

onExecutingODATAQuery?: ((wpInfo, odata) => IODataQuery)

Type declaration

    • (wpInfo, odata): IODataQuery
    • The executing odata query event.

      Parameters

      • wpInfo: IListInfo
      • odata: IODataQuery

      Returns IODataQuery

onPostRender?: ((wp, ...args) => void)

Type declaration

    • (wp, ...args): void
    • The post render event

      Parameters

      • wp: IListInfo
      • Rest ...args: any[]

      Returns void

onRenderDisplay?: ((wp) => any)

Type declaration

    • (wp): any
    • The render event triggered when the page is in 'Display' mode

      Parameters

      • wp: IListInfo

      Returns any

onRenderEdit?: ((wp) => any)

Type declaration

    • (wp): any
    • The render event triggered when the page is in 'Edit' mode

      Parameters

      • wp: IListInfo

      Returns any

onRenderForm?: ((form, wp?) => any)

Type declaration

    • (form, wp?): any
    • The render form event triggered when the form is created

      Parameters

      • form: IForm
      • Optional wp: IListInfo

      Returns any

onRenderItems?: ((wpInfo, items) => void)

Type declaration

    • (wpInfo, items): void
    • The on render items event.

      Parameters

      • wpInfo: IListInfo
      • items: (IListItemQuery | ListItem)[]

      Returns void

wpClassName?: string

The webpart class name

Generated using TypeDoc