Interface ISPFxListFormWebPartProps

SPFx List Form WebPart Properties

Hierarchy

Properties

componentId? componentProps? envType? listQuery? onConfigFormDisplaying? onConfigFormFooterRendering? onConfigFormRendered? onConfigFormRendering? onConfigSaved? onConfigSaving? onDisplayFormRendered? onDisplayFormRendering? onEditFooterRendering? onEditFormRendered? onEditFormRendering? onGetListInfo? onListItemCAMLQuery? onListItemODataQuery? onListsChanged? onListsLoaded? onModalRendered? onModalRendering? onSaved? onSaving? render? renderEdit? renderItems? spfx?

Properties

Optional componentId

componentId?: string

The form component id to use for the edit configuration webpart.

Optional componentProps

componentProps?: string

The form component properties to use for the edit configuration webpart.

Optional envType

envType?: number

The environment type.

Optional listQuery

listQuery?: IODataQuery

The odata list query.

Optional onConfigFormDisplaying

onConfigFormDisplaying?: ((wpCfg?) => void)

Type declaration

    • (wpCfg?): void

    • The event called when the modal is being displayed.

      Parameters

      Returns void

Optional onConfigFormFooterRendering

onConfigFormFooterRendering?: ((props, wpCfg?) => ITooltipGroupProps)

Type declaration

    • (props, wpCfg?): ITooltipGroupProps

    • The webpart configuration modal footer button properties.

      Parameters

      Returns ITooltipGroupProps

Optional onConfigFormRendered

onConfigFormRendered?: ((form, wpCfg?) => void)

Type declaration

    • (form, wpCfg?): void

    • The webpart configuration modal form object.

      Parameters

      Returns void

Optional onConfigFormRendering

onConfigFormRendering?: ((props, wpCfg?) => IFormProps)

Type declaration

    • (props, wpCfg?): IFormProps

    • The webpart configuration modal form properties.

      Parameters

      Returns IFormProps

Optional onConfigSaved

onConfigSaved?: ((wpCfg?) => void)

Type declaration

    • (wpCfg?): void

    • The event called after the webpart configuration is saved.

      Parameters

      Returns void

Optional onConfigSaving

onConfigSaving?: ((wpCfg) => ISPFxListWebPartCfg)

Type declaration

Optional onDisplayFormRendered

onDisplayFormRendered?: ((form?) => void)

Type declaration

    • (form?): void

    • The display form rendered event.

      Parameters

      • Optional form: IListDisplayForm

      Returns void

Optional onDisplayFormRendering

onDisplayFormRendering?: ((props) => IListFormDisplayProps)

Type declaration

Optional onEditFooterRendering

onEditFooterRendering?: ((props) => ITooltipGroupProps)

Type declaration

    • (props): ITooltipGroupProps

    • The footer rendering.

      Parameters

      • props: ITooltipGroupProps

      Returns ITooltipGroupProps

Optional onEditFormRendered

onEditFormRendered?: ((form?) => void)

Type declaration

    • (form?): void

    • The edit form rendered event.

      Parameters

      • Optional form: IListEditForm

      Returns void

Optional onEditFormRendering

onEditFormRendering?: ((props) => IListFormEditProps)

Type declaration

Optional onGetListInfo

onGetListInfo?: ((props) => IListFormProps)

Type declaration

    • (props): IListFormProps

    • The list information properties.

      Parameters

      • props: IListFormProps

      Returns IListFormProps

Optional onListItemCAMLQuery

onListItemCAMLQuery?: ((wpCfg, query) => string)

Type declaration

    • (wpCfg, query): string

    • The event to customize the CAML query used for getting the list items.

      Parameters

      Returns string

Optional onListItemODataQuery

onListItemODataQuery?: ((wpCfg, query) => IODataQuery)

Type declaration

    • (wpCfg, query): IODataQuery

    • The event to customize the ODATA query used for getting the list items.

      Parameters

      Returns IODataQuery

Optional onListsChanged

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

Type declaration

Optional onListsLoaded

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

Type declaration

    • (wpInfo, lists?): (List | IListQuery)[]

    • The lists loaded event.

      Parameters

      • wpInfo: IListInfo
      • Optional lists: (List | IListQuery)[]

      Returns (List | IListQuery)[]

Optional onModalRendered

onModalRendered?: ((modal) => void)

Type declaration

    • (modal): void

    • The webpart configuration modal properties.

      Parameters

      Returns void

Optional onModalRendering

onModalRendering?: ((props) => IModalProps<HTMLElement>)

Type declaration

Optional onSaved

onSaved?: ((item) => void)

Type declaration

    • (item): void

    • The saved event

      Parameters

      • item: any

      Returns void

Optional onSaving

onSaving?: ((values) => any)

Type declaration

    • (values): any

    • The saving event.

      Parameters

      • values: any

      Returns any

Optional render

render?: ((el?, cfg?) => void)

Type declaration

    • (el?, cfg?): void

    • The render event for the webpart.

      Parameters

      Returns void

Optional renderEdit

renderEdit?: ((el?, cfg?) => void)

Type declaration

    • (el?, cfg?): void

    • The render event for the webpart when the page is in edit mode.

      Parameters

      Returns void

Optional renderItems

renderItems?: ((el?, cfg?, items?) => void)

Type declaration

    • (el?, cfg?, items?): void

    • The render event for the webpart.

      Parameters

      • Optional el: HTMLElement
      • Optional cfg: ISPFxListWebPartCfg
      • Optional items: (IListItemQuery | ListItem)[]

      Returns void

Optional spfx

spfx?: {
    context: {
        domElement: HTMLElement;
        graphHttpClient: any;
        host: any;
        httpClient: any;
        instanceId: string;
        itemId?: number;
        list?: {
            title: string;
        };
        manifest: {
            alias: string;
            componentType: string;
            id: string;
            loaderConfig: any;
            manifestVersion: number;
            requiresCustomScript: boolean;
            supportedHosts: string[];
            supportsThemeVariants: boolean;
            version: string;
        };
        pageContext: any;
        propertyPane: any;
        serviceScope: any;
        spHttpClient: any;
        statusRenderer: any;
        webPartTag: string;
    };
    dataVersion: any;
    description: string;
    displayMode: number;
    domElement: HTMLElement;
    formClosed?: (() => void);
    formSaved?: (() => void);
    getPropertyPaneConfiguration: any;
    instanceId: string;
    isRenderAsync: boolean;
    previewImageUrl: string;
    properties: any;
    propertiesMetadata: any;
    title: string;
    width: number;
}

The spfx properties.

Type declaration

  • context: {
        domElement: HTMLElement;
        graphHttpClient: any;
        host: any;
        httpClient: any;
        instanceId: string;
        itemId?: number;
        list?: {
            title: string;
        };
        manifest: {
            alias: string;
            componentType: string;
            id: string;
            loaderConfig: any;
            manifestVersion: number;
            requiresCustomScript: boolean;
            supportedHosts: string[];
            supportsThemeVariants: boolean;
            version: string;
        };
        pageContext: any;
        propertyPane: any;
        serviceScope: any;
        spHttpClient: any;
        statusRenderer: any;
        webPartTag: string;
    }
    • domElement: HTMLElement
    • graphHttpClient: any
    • host: any
    • httpClient: any
    • instanceId: string
    • Optional itemId?: number
    • Optional list?: {
          title: string;
      }
      • title: string
    • manifest: {
          alias: string;
          componentType: string;
          id: string;
          loaderConfig: any;
          manifestVersion: number;
          requiresCustomScript: boolean;
          supportedHosts: string[];
          supportsThemeVariants: boolean;
          version: string;
      }
      • alias: string
      • componentType: string
      • id: string
      • loaderConfig: any
      • manifestVersion: number
      • requiresCustomScript: boolean
      • supportedHosts: string[]
      • supportsThemeVariants: boolean
      • version: string
    • pageContext: any
    • propertyPane: any
    • serviceScope: any
    • spHttpClient: any
    • statusRenderer: any
    • webPartTag: string
  • dataVersion: any
  • description: string
  • displayMode: number
  • domElement: HTMLElement
  • Optional formClosed?: (() => void)
      • (): void

      • Returns void

  • Optional formSaved?: (() => void)
      • (): void

      • Returns void

  • getPropertyPaneConfiguration: any
  • instanceId: string
  • isRenderAsync: boolean
  • previewImageUrl: string
  • properties: any
  • propertiesMetadata: any
  • title: string
  • width: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc