Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPropertyFieldTermSetPickerProps

interface

Public properties of the PropertyFieldTermSetPicker custom field

Hierarchy

Index

Properties

Optional allowMultipleSelections

allowMultipleSelections: boolean
var

Defines if the user can select only one or many term sets. Default value is false.

context

context: IWebPartContext
var

WebPart's context

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.

Optional displayOnlyTermSetsAvailableForTagging

displayOnlyTermSetsAvailableForTagging: boolean
var

Restrict term sets that are available for tagging. Default is false.

Optional excludeOfflineTermStores

excludeOfflineTermStores: boolean
var

Indicates if the offline term stores must be exclude. Default is false.

Optional excludeSystemGroup

excludeSystemGroup: boolean
var

Indicator to define if the system Groups are exclude. Default is false.

Optional initialValues

initialValues: ISPTermSets
var

Defines the selected by default term sets.

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

    • Parameters

      Returns string | Promise<string>

panelTitle

panelTitle: string
var

TermSet Picker Panel title

properties

properties: any
var

Parent Web Part properties

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