Interface IWebPartProps<IWPInfo, IWPEditForm>

WebPart Properties

Type Parameters

Hierarchy

Properties

cfgElementId? className? editForm? elementId? helpProps? onPostRender? onRenderDisplay? onRenderEdit? onRenderForm? wpClassName?

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, ...args) => void)

Type declaration

    • (wp, ...args): void

    • The post render event

      Parameters

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

      Returns void

Optional onRenderDisplay

onRenderDisplay?: ((wp) => any)

Type declaration

    • (wp): any

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

      Parameters

      • wp: IWPInfo

      Returns any

Optional onRenderEdit

onRenderEdit?: ((wp) => any)

Type declaration

    • (wp): any

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

      Parameters

      • wp: IWPInfo

      Returns any

Optional onRenderForm

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

Type declaration

    • (form, wp?): any

    • The render form event triggered when the form is created

      Parameters

      • form: IForm
      • Optional wp: IWPInfo

      Returns any

Optional wpClassName

wpClassName?: string

The webpart class name

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc