PlaceholderProvider class
Позволяет сторонним компонентам обнаруживать и использовать заполнители SharePoint. Заполнители позволяют сторонним компонентам отображать пользовательское содержимое в указанных регионах на странице.
Комментарии
Заполнители — это регионы на странице, определяемые одной из предопределенных констант PlaceholderName . Разные приложения и страницы могут поддерживать разные имена заполнителей. Заполнители могут появляться и исчезать при взаимодействии пользователя со страницей, например с помощью навигации на месте. Сторонние компоненты не должны предполагать, что заданный заполнитель всегда будет доступен.
Используйте метод PlaceholderProvider.tryCreateContent(), чтобы проверить, доступен ли заполнитель и добавить в него содержимое. Используйте событие PlaceholderProvider.changedEvent , чтобы обнаружить, когда появляются новые заполнители.
Конструктор для этого класса помечен как внутренний. Сторонний код не должен напрямую вызывать конструктор или создавать подклассы, расширяющие класс PlaceholderProvider.
Свойства
| is |
|
| placeholder |
Возвращает имена доступных в настоящее время заполнителей. |
Методы
| dispose() | |
| try |
Проверяет, содержит ли страница указанный заполнитель. В этом случае создается новый объект PlaceholderContent, который позволяет вызывающей отрисовке пользовательского содержимого внутри заполнителя. |
События
| changed |
Это событие возникает при изменении списка доступных заполнителей. |
Сведения о свойстве
isDisposed
get isDisposed(): boolean;Значение свойства
boolean
placeholderNames
Возвращает имена доступных в настоящее время заполнителей.
get placeholderNames(): ReadonlyArray<PlaceholderName>;Значение свойства
ReadonlyArray<PlaceholderName>
Сведения о методе
dispose()
dispose(): void;Возвращаемое значение
void
tryCreateContent(name, options)
Проверяет, содержит ли страница указанный заполнитель. В этом случае создается новый объект PlaceholderContent, который позволяет вызывающей отрисовке пользовательского содержимого внутри заполнителя.
tryCreateContent(name: PlaceholderName, options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined;Параметры
- name
- PlaceholderName
Запрошенный заполнитель
- options
- IPlaceholderCreateContentOptions
Дополнительные параметры, например для определения того, когда заполнитель удаляется.
Возвращаемое значение
PlaceholderContent | undefined
Новый объект PlaceholderContent или undefined, если запрошенный заполнитель не существует.
Комментарии
Ведущее приложение не дает никаких гарантий о доступности заданного заполнителя. В ситуациях, когда ожидаемый заполнитель недоступен, стороннее расширение должно правильно обрабатывать его, например, не отображая ничего или выбрав альтернативный заполнитель.
Сведения о событии
changedEvent
Это событие возникает при изменении списка доступных заполнителей.
get changedEvent(): SPEvent<SPEventArgs>;Тип события
Комментарии
Приложение может изменить список доступных заполнителей в любое время. Это означает, что существующие заполнители могут быть удалены или добавлены новые заполнители. Используйте это событие для обнаружения новых заполнителей при их появлении.