IPropertyPaneDynamicTextFieldProps interface

Пакет:

@microsoft/sp-property-pane

Предупреждение

Теперь этот API является нерекомендуемым.

• This has been replaced by IPropertyPaneDynamicFieldProps

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

PropertyPaneDynamicData реквизит компонента.

Свойства

ariaLabel	Метка ARIA для текстового поля, если оно есть.
description	Описание входных данных текстового поля.
disabled	Включено ли текстовое поле области свойств.
errorMessage	Если задано значение , оно будет отображаться в виде сообщения об ошибке.
label	Метка для текстового поля.
onGetErrorMessage	Этот метод используется для получения сообщения об ошибке проверки и определения допустимости входного значения.
placeholder	Замещающий текст, отображаемый в текстовом поле.
validateOnFocusIn	Выполните проверку, когда свойство PropertyPaneTextField сосредоточено.
validateOnFocusOut	Выполните проверку, PropertyPaneTextField когда объект находится вне фокуса или при размытии.
value	Значение, отображаемое в текстовом поле, если значение targetProperty в контейнере свойств манифеста пусто или содержит значение NULL.

Сведения о свойстве

ariaLabel

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Метка ARIA для текстового поля, если оно есть.

ariaLabel?: string;

Значение свойства

string

description

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Описание входных данных текстового поля.

description?: string;

Значение свойства

string

disabled

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Включено ли текстовое поле области свойств.

disabled?: boolean;

Значение свойства

boolean

errorMessage

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Если задано значение , оно будет отображаться в виде сообщения об ошибке.

errorMessage?: string;

Значение свойства

string

Комментарии

Если onGetErrorMessage возвращает пустую строку, если это свойство имеет значение, оно будет отображаться как сообщение об ошибке.

Убедитесь, что этот параметр задан только в том случае, если для текстового поля отображается сообщение об ошибке.

label

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Метка для текстового поля.

label?: string;

Значение свойства

string

onGetErrorMessage

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Этот метод используется для получения сообщения об ошибке проверки и определения допустимости входного значения.

onGetErrorMessage?: (value: string) => string | Promise<string>;

Значение свойства

(value: string) => string | Promise<string>

Комментарии

При возврате строки:

• Если это допустимо, возвращается пустая строка.

• Если это недопустимо, возвращается строка сообщения об ошибке, а под текстовым полем отображается сообщение об ошибке.

Когда возвращается Promise<string>:

• Разрешенное значение отображается как сообщение об ошибке.

• Отклонено, значение выброшено.

placeholder

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Замещающий текст, отображаемый в текстовом поле.

placeholder?: string;

Значение свойства

string

validateOnFocusIn

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Выполните проверку, когда свойство PropertyPaneTextField сосредоточено.

validateOnFocusIn?: boolean;

Значение свойства

boolean

Комментарии

Значение по умолчанию — false.

validateOnFocusOut

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Выполните проверку, PropertyPaneTextField когда объект находится вне фокуса или при размытии.

validateOnFocusOut?: boolean;

Значение свойства

boolean

Комментарии

Значение по умолчанию — false.

value

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Значение, отображаемое в текстовом поле, если значение targetProperty в контейнере свойств манифеста пусто или содержит значение NULL.

value?: string;

Значение свойства

string