Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPropertyFieldSortableListProps

interface

Public properties of the PropertyFieldSortableList custom field

Hierarchy

Index

Properties

Methods

Properties

Optional deferredValidationTime

deferredValidationTime: number

Custom Field will start to validate after users stop typing for deferredValidationTime milliseconds. Default value is 200.

Optional disabled

disabled: boolean

Whether the property pane field is enabled or not.

items

items: IChoiceGroupOption[]
var

Sortable list options

Optional key

key: string
var

An UNIQUE key indicates the identity of this control

label

label: string
var

Property field label displayed on top

Optional onGetErrorMessage

onGetErrorMessage: function

The method is used to get the validation error message and determine whether the input value is valid or not.

When it returns string:

  • If valid, it returns empty string.

  • If invalid, it returns the error message string and the text field will show a red border and show an error message below the text field.

    When it returns Promise:

  • The resolved value is display as error message.
  • The rejected, the value is thrown away.

Type declaration

    • (value: string[]): string | Promise<string>

    • Parameters

      • value: string[]

      Returns string | Promise<string>

properties

properties: any
var

Parent Web Part properties

Optional selectedItems

selectedItems: string[]
var

Default selected values of the picker (must be a collection of list keys)

Optional sortBy

sortBy: ISortableListOrder
var

Defines the sort by criteria (default is Text)

Methods

onPropertyChange

  • onPropertyChange(propertyPath: string, oldValue: any, newValue: any): void
  • function

    Defines a onPropertyChange function to raise when the selected value changed. Normally this function must be always defined with the 'this.onPropertyChange' method of the web part object.

    Parameters

    • propertyPath: string
    • oldValue: any
    • newValue: any

    Returns void

Generated using TypeDoc