通过

PlaceholderContent class

  • 参考
包:
@microsoft/sp-application-base

表示在 SharePoint 页面上的占位符内呈现的自定义内容。

注解

此对象由 PlaceholderProvider.tryCreateContent () 返回。 它提供对文档对象模型 (DOM) 元素的访问权限，所有者可在其中呈现其自定义内容。

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

属性

domElement

文档对象模型 (DOM) 元素，所有者应在其中呈现其自定义内容。
isDisposed
isVisible

如果此 PlacholderContent 对象可见，则返回 true。 如果创建占位符，但主机页未显示它，则返回 false。
name

标识此内容已添加到的占位符。

方法

dispose()

释放 PlaceholderContent 对象，并从页面中删除其附加的 DOM 元素。

属性详细信息

domElement

文档对象模型 (DOM) 元素，所有者应在其中呈现其自定义内容。

get domElement(): HTMLDivElement;

属性值

HTMLDivElement

注解

如果在释放 DOM 元素时需要通知调用方，请使用 IPlaceholderCreateContentOptions.onDispose 回调。

isDisposed 

get isDisposed(): boolean;

属性值

boolean

isVisible

如果此 PlacholderContent 对象可见，则返回 true。 如果创建占位符，但主机页未显示它，则返回 false。

get isVisible(): boolean;

属性值

boolean

name

标识此内容已添加到的占位符。

get name(): PlaceholderName;

属性值

PlaceholderName

注解

示例：PlaceholderName.Top

方法详细信息

dispose()

释放 PlaceholderContent 对象，并从页面中删除其附加的 DOM 元素。

dispose(): void;

返回

void

注解

可以调用此方法来立即释放附加的 DOM 元素。 否则，当释放包含占位符时，应用程序将释放它。 调用 dispose () 调用 IPlaceholderCreateContentOptions.onDispose 回调，从页面中删除关联的 DOM 元素，并释放 PlaceholderContent 对象。