BaseComponent class

客户端组件(如 BaseClientSideWebPart 或 BaseExtension)的基类。

注解

此类的构造函数标记为内部。 第三方代码不应直接调用构造函数或创建扩展类的 BaseComponent 子类。

属性

componentId

返回组件的关联清单中定义的组件标识符。

context

使用上下文对象访问与组件关联的常见服务和状态。

instanceId

组件实例的唯一标识符。

isDisposed

如果组件已释放,则返回 true。

manifest

提供对客户端组件的清单的访问。 虚拟

方法

dispose()

释放组件。

onDispose()

此事件方法在组件的生命周期结束时调用。 它提供了释放任何关联资源、取消任何未完成的请求等虚拟资源的机会。

属性详细信息

componentId

返回组件的关联清单中定义的组件标识符。

get componentId(): string;

属性值

string

注解

每个客户端组件都有一个关联的清单,sp-loader 使用该清单来加载其脚本,其中可能包括有关该组件的其他元数据。 清单使用包含小写 GUID 值的文本字符串进行唯一标识。

context

使用上下文对象访问与组件关联的常见服务和状态。

protected context?: BaseComponentContext;

属性值

注解

子类应通过用专用类型重新声明此字段来替代此字段。 它是只读属性;类型不能在基类中声明为只读 (,因为它是在构造函数) 外部初始化的,但子类应将其重新声明为只读。

instanceId

组件实例的唯一标识符。

get instanceId(): string;

属性值

string

注解

组件实现可以在页面上多次加载。 例如,如果组件是一个图表 Web 部件,则此 Web 部件的多个实例可以添加到 SharePoint 画布。 instanceId 唯一标识其中每个实例。

isDisposed

如果组件已释放,则返回 true。

get isDisposed(): boolean;

属性值

boolean

manifest

提供对客户端组件的清单的访问。 虚拟

get manifest(): IClientSideComponentManifest;

属性值

注解

子类可以使用更专用的清单类型替代此类型。

方法详细信息

dispose()

释放组件。

dispose(): void;

返回

void

注解

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

onDispose()

此事件方法在组件的生命周期结束时调用。 它提供了释放任何关联资源、取消任何未完成的请求等虚拟资源的机会。

protected onDispose(): void;

返回

void