Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IWPListFieldsProps<IListFieldsInfo, IListFieldsEditForm>

List Fields WebPart Properties

Type parameters

  • IListFieldsInfo

  • IListFieldsEditForm

Hierarchy

  • IWPListProps<IListFieldsInfo, IListFieldsEditForm>
    • IWPListFieldsProps

Index

Properties

Optional camlQuery

camlQuery: string

The caml query.

Optional cfgElementId

cfgElementId: string

The optional configuration element

Optional className

className: string

The class name.

Optional editForm

editForm: IListFieldsEditForm

The edit form

Optional elementId

elementId: string

The target element id to render the webpart to

Optional helpProps

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

The optional help link properties

Type declaration

  • Optional title?: string

    The link title

  • url: string

    The link url

Optional odataQuery

odataQuery: IODataQuery

The odata query.

Optional onExecutingCAMLQuery

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

The executing caml query event.

Type declaration

    • (wpInfo: IListFieldsInfo, caml: string): string
    • Parameters

      • wpInfo: IListFieldsInfo
      • caml: string

      Returns string

Optional onExecutingODATAQuery

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

The executing odata query event.

Type declaration

    • (wpInfo: IListFieldsInfo, odata: IODataQuery): IODataQuery
    • Parameters

      • wpInfo: IListFieldsInfo
      • odata: IODataQuery

      Returns IODataQuery

Optional onPostRender

onPostRender: (wp: IListFieldsInfo, ...args: any[]) => void

The post render event

Type declaration

    • (wp: IListFieldsInfo, ...args: any[]): void
    • Parameters

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

      Returns void

Optional onRenderDisplay

onRenderDisplay: (wp: IListFieldsInfo) => any

The render event triggered when the page is in 'Display' mode

Type declaration

    • (wp: IListFieldsInfo): any
    • Parameters

      • wp: IListFieldsInfo

      Returns any

Optional onRenderEdit

onRenderEdit: (wp: IListFieldsInfo) => any

The render event triggered when the page is in 'Edit' mode

Type declaration

    • (wp: IListFieldsInfo): any
    • Parameters

      • wp: IListFieldsInfo

      Returns any

Optional onRenderItems

onRenderItems: (wpInfo: IListFieldsInfo, items: Array<IListItemQuery | ListItem>) => void

The on render items event.

Type declaration

    • (wpInfo: IListFieldsInfo, items: Array<IListItemQuery | ListItem>): void
    • Parameters

      • wpInfo: IListFieldsInfo
      • items: Array<IListItemQuery | ListItem>

      Returns void

Optional wpClassName

wpClassName: string

The webpart class name

Generated using TypeDoc