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


IWebPartContext interface

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

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

  • This interface will be removed in an upcoming release. Use the WebPartContext class instead.

Интерфейс базового контекста для клиентских веб-частей.

Комментарии

Объект context — это коллекция хорошо известных служб и других объектов, которые, скорее всего, потребуются любой бизнес-логике, работающей с компонентом. Каждый тип компонента имеет собственное специализированное расширение этого интерфейса, например IWebPartContext для веб-частей, IExtensionContext для расширений на стороне клиента и т. д.

Свойства

domElement

Ссылка на элемент DOM, в котором размещается этот клиентский компонент.

httpClient

Экземпляр HttpClient, связанный с этой веб-частью.

instanceId

Идентификатор экземпляра веб-части. Это глобальное уникальное значение.

manifest

Манифест для клиентской веб-части.

pageContext

Контекст страницы SharePoint.

propertyPane

Метод доступа к распространенным операциям области свойств веб части.

spHttpClient

Экземпляр SPHttpClient, связанный с этой веб-частью.

statusRenderer

Отрисовщик состояния веб-части.

webPartTag

Тег веб-части, используемый для ведения журнала и телеметрии.

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

domElement

Ссылка на элемент DOM, в котором размещается этот клиентский компонент.

readonly domElement: HTMLElement;

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

HTMLElement

httpClient

Экземпляр HttpClient, связанный с этой веб-частью.

readonly httpClient: HttpClient;

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

instanceId

Идентификатор экземпляра веб-части. Это глобальное уникальное значение.

readonly instanceId: string;

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

string

manifest

Манифест для клиентской веб-части.

readonly manifest: IClientSideWebPartManifestInstance<any>;

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

pageContext

Контекст страницы SharePoint.

readonly pageContext: PageContext;

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

propertyPane

Метод доступа к распространенным операциям области свойств веб части.

readonly propertyPane: IPropertyPaneAccessor;

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

spHttpClient

Экземпляр SPHttpClient, связанный с этой веб-частью.

readonly spHttpClient: SPHttpClient;

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

statusRenderer

Отрисовщик состояния веб-части.

readonly statusRenderer: IClientSideWebPartStatusRenderer;

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

webPartTag

Тег веб-части, используемый для ведения журнала и телеметрии.

readonly webPartTag: string;

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

string