Interface IHelper

Helper Methods

Hierarchy

  • IHelper

Properties

renderEditForm

Methods

getWebPart getWebPartId saveConfiguration updateConfigurationInElement updateWebPartContentElements

Properties

renderEditForm

renderEditForm: ((el, wpCfg, formControls) => IForm)

Type declaration

    • (el, wpCfg, formControls): IForm

    • Method to render the edit form.

      Parameters

      • el: HTMLElement

        The element to render the form to.

      • wpCfg: IWebPartCfg

        The webpart configuration information.

      • formControls: IFormControlProps[]

        The form controls to render.

      Returns IForm

Methods

getWebPart

getWebPartId

  • Method to get the webpart id for a specified element

    Parameters

    • el: HTMLElement

      The target element.

    Returns string

saveConfiguration

  • Method to save the webpart configuration. This method may execute a postback, based on the page type.

    Parameters

    • wpId: string

      The webpart id.

    • Optional cfgId: string
    • Optional wpCfg: any

      The webpart configuration.

    Returns PromiseLike<void>

updateConfigurationInElement

  • Method to update the configuration element

    Parameters

    • cfgId: string
    • elTarget: HTMLInputElement

      The target element.

    • wpCfg: any

      The webpart configuration.

    Returns any

updateWebPartContentElements

  • Method to update the webpart content elements

    Parameters

    • wpId: string

      The webpart id.

    • Optional cfgId: string
    • Optional wpCfg: any

      The webpart configuration.

    Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc