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 对象，如果请求的占位符不存在，则为未定义。
注解
主机应用程序不保证给定占位符的可用性。 在预期占位符不可用的情况下，第三方扩展必须正常处理它，例如，不呈现任何内容，或者选择备用占位符。
事件详细信息
changedEvent
更改当前可用占位符的列表时，将引发此事件。
get changedEvent(): SPEvent<SPEventArgs>;事件类型
注解
应用程序可以随时更改其可用占位符的列表。 这意味着可能会释放现有占位符或添加新占位符。 使用此事件在出现新占位符时发现它们。