Interface IWPSearchProps

Search WebPart Properties

Hierarchy

Properties

camlQuery? cfgElementId? className? editForm? elementId? helpProps? odataQuery? onExecutingCAMLQuery? onExecutingODATAQuery? onPostRender? onRenderDisplay? onRenderEdit? onRenderForm? onRenderItems? searchFields? wpClassName?

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?: IWPSearchEditForm

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, caml) => string)

Type declaration

    • (wpInfo, caml): string

    • The executing caml query event.

      Parameters

      Returns string

Optional onExecutingODATAQuery

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

Type declaration

    • (wpInfo, odata): IODataQuery

    • The executing odata query event.

      Parameters

      Returns IODataQuery

Optional onPostRender

onPostRender?: ((wp, ...args) => void)

Type declaration

    • (wp, ...args): void

    • The post render event

      Parameters

      Returns void

Optional onRenderDisplay

onRenderDisplay?: ((wp) => any)

Type declaration

    • (wp): any

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

      Parameters

      Returns any

Optional onRenderEdit

onRenderEdit?: ((wp) => any)

Type declaration

    • (wp): any

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

      Parameters

      Returns any

Optional onRenderForm

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

Type declaration

    • (form, wp?): any

    • The render form event triggered when the form is created

      Parameters

      Returns any

Optional onRenderItems

onRenderItems?: ((wpInfo, items) => void)

Type declaration

    • (wpInfo, items): void

    • The on render items event.

      Parameters

      Returns void

Optional searchFields

searchFields?: {
    name: string;
    type: string;
}[]

The internal field names to be used for search. These will be appended to the configuration fields.

Type declaration

  • name: string
  • type: string

Optional wpClassName

wpClassName?: string

The webpart class name

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc