IPropertyPaneTextFieldProps interface

Пакет:

@microsoft/sp-property-pane

Реквизиты компонента PropertyPaneTextField.

Свойства

ariaLabel	Метка Aria для текстового поля, если оно есть.
deferredValidationTime	Проверка текстового поля начнется через deferredValidationTime миллисекунд после того, как пользователь перестанет печатать.
description	Описание входных данных текстового поля.
disabled	Включено ли текстовое поле области свойств.
errorMessage	Если задано значение , оно будет отображаться в виде сообщения об ошибке.
label	Метка для текстового поля.
logName	Имя, используемое для регистрации PropertyPaneTextField изменений значений для отслеживания взаимодействия.
maxLength	Максимальное количество символов, которое может иметь PropertyPaneTextField.
multiline	Указывает, является ли текстовое поле многострокным.
onGetErrorMessage	Метод используется для проверки сообщения об ошибке и введенного значения.
placeholder	замещающий текст, отображаемый в текстовом поле.
resizable	Можно ли изменять размер многострочного текстового поля.
rows	Указывает видимую высоту текстовой области (многострочный text TextField) в строках.
underlined	Указывает, подчеркнут ли текстовое поле.
validateOnFocusIn	Выполните проверку, когда свойство PropertyPaneTextField сосредоточено.
validateOnFocusOut	Запустите проверку, если свойство PropertyPaneTextField находится вне фокуса или при размытии.
value	Значение, отображаемое в текстовом поле, если значение targetProperty в контейнере свойств манифеста пусто или содержит значение NULL.

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

ariaLabel

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

ariaLabel?: string;

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

string

deferredValidationTime

Проверка текстового поля начнется через deferredValidationTime миллисекунд после того, как пользователь перестанет печатать.

deferredValidationTime?: number;

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

number

Комментарии

Значение по умолчанию: 200.

description

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

description?: string;

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

string

disabled

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

disabled?: boolean;

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

boolean

errorMessage

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

errorMessage?: string;

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

string

Комментарии

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

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

label

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

label?: string;

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

string

logName

Имя, используемое для регистрации PropertyPaneTextField изменений значений для отслеживания взаимодействия.

logName?: {
        moduleName: string;
        controlName: string;
    };

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

{ moduleName: string; controlName: string; }

Комментарии

Сообщения будут регистрироваться в формате , <moduleName>.<controlName>например .

Например, если {moduleName: 'ImageWebPart', controlName: 'OverlayText'} задан параметр , журнал взаимодействия может содержать:

1. Тип действия:

Add: измените исходное или ненастроенное состояние на настроенное содержимое. (первая правка)

Clear: сбрасывает содержимое элемента заголовка в исходное или ненастроенное состояние.

Edit: любой выпуск, изменяющий содержимое, кроме добавления и очистки

2. Длина текста после каждого изменения

maxLength

Максимальное количество символов, которое может иметь PropertyPaneTextField.

maxLength?: number;

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

number

Комментарии

Если для значения задано отрицательное число, возникнет исключение.

multiline

Указывает, является ли текстовое поле многострокным.

multiline?: boolean;

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

boolean

Комментарии

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

onGetErrorMessage

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

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

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

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

Комментарии

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

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

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

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

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

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

placeholder

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

placeholder?: string;

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

string

resizable

Можно ли изменять размер многострочного текстового поля.

resizable?: boolean;

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

boolean

Комментарии

Значение по умолчанию: true.

rows

Указывает видимую высоту текстовой области (многострочный text TextField) в строках.

rows?: number;

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

number

Комментарии

Эта опора используется только в том случае, если для многострокового реквизита задано значение true.

underlined

Указывает, подчеркнут ли текстовое поле.

underlined?: boolean;

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

boolean

Комментарии

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

validateOnFocusIn

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

validateOnFocusIn?: boolean;

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

boolean

Комментарии

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

validateOnFocusOut

Запустите проверку, если свойство PropertyPaneTextField находится вне фокуса или при размытии.

validateOnFocusOut?: boolean;

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

boolean

Комментарии

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

value

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

value?: string;

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

string