Поделиться через

IComponentPropertyMetadata interface

  • Ссылка
Пакет:
@microsoft/sp-component-base

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

Свойства

isHtmlString

Указывает, следует ли сериализовать свойство в формате HTML.
isImageSource

Указывает, содержит ли свойство ссылку. Это позволяет серверу SharePoint обрабатывать значение как таковое и выполнять такие службы, как исправление ссылок, индексирование поиска, загрузка из CDN и т. д.
isLink

Указывает, содержит ли свойство ссылку. Это позволяет серверу SharePoint обрабатывать значение как таковое и выполнять такие службы, как индексирование поиска, исправление ссылок, загрузка из CDN и т. д.
isSearchablePlainText

Указывает, содержит ли свойство обычный текст, который должен индексироваться в SharePoint.
shouldNotPersist

Указывает, должна ли платформа сохранять свойство на сервере.

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

isHtmlString

Указывает, следует ли сериализовать свойство в формате HTML.

isHtmlString?: boolean;

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

boolean

Комментарии

Этот флаг указывает платформе хранить значение в формате HTML, чтобы SharePoint могла выполнять на нем следующие службы:

  • нормализация кодировки HTML

  • удаление небезопасных тегов HTML (т. е. для использования с Element.innerHTML)

  • индексирование поиска

  • Исправление ссылок в SharePoint

Включите этот флаг только для содержимого HTML, если эти изменения допустимы. Если предоставляется содержимое, отличное от HTML, платформа SharePoint может внести изменения, чтобы преобразовать его в допустимый HTML-код. Для содержимого в виде обычного текста, которое просто должно быть предоставлено индексу поиска (без перезаписи), используйте isSearchablePlainText вместо него флаг .

isImageSource

Указывает, содержит ли свойство ссылку. Это позволяет серверу SharePoint обрабатывать значение как таковое и выполнять такие службы, как исправление ссылок, индексирование поиска, загрузка из CDN и т. д.

isImageSource?: boolean;

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

boolean

Указывает, содержит ли свойство ссылку. Это позволяет серверу SharePoint обрабатывать значение как таковое и выполнять такие службы, как индексирование поиска, исправление ссылок, загрузка из CDN и т. д.

isLink?: boolean;

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

boolean

isSearchablePlainText

Указывает, содержит ли свойство обычный текст, который должен индексироваться в SharePoint.

isSearchablePlainText?: boolean;

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

boolean

Комментарии

Этот флаг указывает платформе хранить свойство в представлении, которое поддерживает индексирование поиска. Содержимое будет обрабатываться как обычный текст; SharePoint не изменит строку каким-либо образом, а специальные HTML-символы могут храниться в кодировке и отображаться в результатах поиска. Если строка содержит разметку HTML, используйте параметр isHtmlString.

Примечание по безопасности. По соображениям безопасности никогда не назначайте строку Element.innerHTMLв виде обычного текста .

shouldNotPersist

Указывает, должна ли платформа сохранять свойство на сервере.

shouldNotPersist?: boolean;

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

boolean

Комментарии

Используйте его для свойств, которые важны только во время выполнения и не должны сохраняться на сервере. Это позволяет уменьшить размер сериализованных данных компонента и оптимизировать время загрузки компонента. Значение свойства будет удалено из сериализованных данных, отправляемых на сервер, но это не влияет на контейнер свойств времени выполнения. Значение свойства по-прежнему будет доступно в методе onBeforeSerialize() , и значение не будет очищено из контейнера свойств времени выполнения. Исходная отрисовка компонента не должна зависеть от значения свойства . Задание значения по умолчанию для свойства можно выполнить в методе onInit() .

Обратите внимание, что если путь к свойству ссылается на свойство со сложным объектом в качестве значения, то весь объект будет удален из сохраненных данных.