Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IWebPartProps<IWPInfo, IWPEditForm>

WebPart Properties

Type parameters

  • IWPInfo

  • IWPEditForm

Hierarchy

Index

Properties

Properties

Optional cfgElementId

cfgElementId: string

The optional configuration element

Optional className

className: string

The class name.

Optional editForm

editForm: IWPEditForm

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 onPostRender

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

The post render event

Type declaration

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

    • Parameters

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

      Returns void

Optional onRenderDisplay

onRenderDisplay: (wp: IWPInfo) => any

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

Type declaration

    • (wp: IWPInfo): any

    • Parameters

      • wp: IWPInfo

      Returns any

Optional onRenderEdit

onRenderEdit: (wp: IWPInfo) => any

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

Type declaration

    • (wp: IWPInfo): any

    • Parameters

      • wp: IWPInfo

      Returns any

Optional wpClassName

wpClassName: string

The webpart class name

Generated using TypeDoc