BaseApplicationCustomizer class

这是第三方在实现在应用程序首次启动时运行的客户端扩展时应扩展的基类。

扩展

BaseExtension<TProperties>

注解

在组件清单中,“extensionType”应设置为“ApplicationCustomizer”。

应用程序自定义工具的示例使用方案可能包括:在 SharePoint 内容占位符内呈现自定义 UI 元素、跟踪页面加载统计信息,或在特定时间段后自动注销用户。

属性

_dynamicDataSourceId

重写BaseComponent._dynamicDataSourceId以排除实例 ID。应用程序自定义工具的实例 ID 按会话更改。

context

方法

dispose()

释放组件。

onPlaceholdersChanged(placeholderProvider)

当主机应用程序的占位符更改、存在或消失时,将调用此事件方法。 虚拟

属性详细信息

_dynamicDataSourceId

重写BaseComponent._dynamicDataSourceId以排除实例 ID。应用程序自定义工具的实例 ID 按会话更改。

get _dynamicDataSourceId(): string;

属性值

string

context

protected readonly context: ApplicationCustomizerContext;

属性值

方法详细信息

dispose()

释放组件。

dispose(): void;

返回

void

注解

第三方代码通常不需要调用此方法;当 Web 部件或扩展的生命周期结束时,会自动调用它。 若要在释放组件时执行自定义清理,请重写 方法。

onPlaceholdersChanged(placeholderProvider)

当主机应用程序的占位符更改、存在或消失时,将调用此事件方法。 虚拟

protected onPlaceholdersChanged(placeholderProvider: PlaceholderProvider): void;

参数

placeholderProvider
PlaceholderProvider

返回

void