页面转换函数和选择器

摘要

默认页面转换配置 (webpartmapping.xml) 使用内置函数和选择器来驱动从经典 Web 部件到新式第一方和第三方 Web 部件的映射。 此页列出了所有可用的函数。

注意

此页面是自动生成的，如果发现问题，请针对相应的转换框架基本代码创建 PR。

函数

HtmlEncode

描述： 返回此字符串的 html 编码值。

              示例：{EncodedText} = HtmlEncode({Text})

输入参数

名称	说明
{Text}	文本到 html 编码

输出参数

名称	说明
{EncodedText}	Html 编码文本

HtmlEncodeForJson

描述： 返回此字符串的 json html 编码值。

              示例：{JsonEncodedText} = HtmlEncodeForJson({Text})

输入参数

名称	说明
{Text}	文本到 html 编码以包含在 json 中

输出参数

名称	说明
{JsonEncodedText}	要包含在 json 文件中的 Html 编码文本

ReturnTrue

描述： 只需返回字符串 true。

              示例：{UsePlaceHolders} = ReturnTrue()

输出参数

名称	说明
{UsePlaceHolders}	值 true

ReturnFalse

描述： 只需返回字符串 false。

              示例：{UsePlaceHolders} = ReturnFalse()

输出参数

名称	说明
{UsePlaceHolders}	值 false

ReturnServerRelativePath

描述： 将传入路径转换为服务器相对路径。

              示例：{ServerRelativePath} = ReturnServerRelativePath({Path})

输入参数

名称	说明
{Path}	要转换的路径

输出参数

名称	说明
{ServerRelativePath}	服务器相对路径

ReturnFileName

描述： 返回给定路径的文件名。

              示例：{FileName} = ReturnFileName({Path})

输入参数

名称	说明
{Path}	要分析的路径

输出参数

名称	说明
{FileName}	具有给定路径中扩展名的文件名

连接

描述： 连接 2 个字符串。

              示例：{CompleteString} = Concatenate({String1},{String2})

输入参数

名称	说明
{String1}	第一个字符串
{String2}	第二个字符串

输出参数

名称	说明
{CompleteString}	传递的字符串的串联

ConcatenateWithSemiColonDelimiter

描述： 连接 2 个字符串，中间有分号。

              示例：{CompleteString} = ConcatenateWithSemiColonDelimiter({String1},{String2})

输入参数

名称	说明
{String1}	第一个字符串
{String2}	第二个字符串

输出参数

名称	说明
{CompleteString}	传递的字符串的串联

ConcatenateWithPipeDelimiter

描述： 连接 2 个字符串，中间有一个管道字符。

              示例：{CompleteString} = ConcatenateWithSemiColonDelimiter({String1},{String2})

输入参数

名称	说明
{String1}	第一个字符串
{String2}	第二个字符串

输出参数

名称	说明
{CompleteString}	传递的字符串的串联

StaticString

描述： 返回作为输入提供的 (静态) 字符串

              示例：StaticString('static string')

输入参数

名称	说明
{'static string'}	静态输入字符串

输出参数

名称	说明
{return value}	作为输入提供的字符串

TextCleanup

描述： 重写 wiki 页面 html，以符合客户端文本部件支持的 html。

              示例：{CleanedText} = TextCleanup({Text},{UsePlaceHolders})

输入参数

名称	说明
{Text}	原始 wiki html 内容
{UsePlaceHolders}	指示是否必须为 wiki html 中不支持的 img/iframe 元素包含占位符的参数

输出参数

名称	说明
{CleanedText}	符合客户端文本部件的 Html

ContainsScript

描述： 检查提供的 html 是否包含 JavaScript

              示例：{HasScript} = ContainsScript({Text})

输入参数

名称	说明
{Text}	要检查的 Html 内容

输出参数

名称	说明
{HasScript}	True 为 html 包含脚本，否则为 false

ListCrossSiteCheck

描述： 返回跨网站集保存列表 ID。

              示例：{ListId} = ListCrossSiteCheck({ListId})

输入参数

名称	说明
{ListId}	要使用的列表的 Guid

输出参数

名称	说明
{ListId}	跨网站集安全列表 ID

ListAddServerRelativeUrl

描述： 返回列表的服务器相对 URL。

              示例：{ListServerRelativeUrl} = ListAddServerRelativeUrl({ListId})

输入参数

名称	说明
{ListId}	要使用的列表的 Guid

输出参数

名称	说明
{ListServerRelativeUrl}	列表的服务器相对 URL

ListAddWebRelativeUrl

描述： 返回列表的 Web 相对 URL。

              示例：{ListWebRelativeUrl} = ListAddWebRelativeUrl({ListId})

输入参数

名称	说明
{ListId}	要使用的列表的 Guid

输出参数

名称	说明
{ListWebRelativeUrl}	列表的 Web 相对 URL

ListHideToolBar

描述： 检查 XSLTListView Web 部件是否具有隐藏的工具栏。

              示例：{HideToolBar} = ListHideToolBar({XmlDefinition})

输入参数

名称	说明
{XmlDefinition}	XSLTListViewWebPart 的 XmlDefinition 属性

输出参数

名称	说明
{HideToolBar}	指示是否应隐藏工具栏的布尔值

ListDetectUsedView

描述： 通过将 Web 部件 xmldefinition 映射到列表视图来检测 Web 部件使用的列表视图 ID。 如果未找到任何视图，则返回列表默认视图 ID。

              示例：{ListViewId} = ListDetectUsedView({ListId},{XmlDefinition})

输入参数

名称	说明
{ListId}	要分析的列表的 Guid
{XmlDefinition}	XSLTListViewWebPart 的 XmlDefinition 属性

输出参数

名称	说明
{ListViewId}	要使用的视图的 ID

ImageLookup

描述： 根据给定的服务器相对路径查找文件，并返回该文件的所需属性。 如果未找到文件，则返回 null。

              示例：ImageLookup({ServerRelativeFileName})

输入参数

名称	说明
{ServerRelativeFileName}	映像的服务器相对文件名

输出参数

名称	说明
{ImageListId}	包含文件的列表的 ID
{ImageUniqueId}	文件的 UniqueId

ReturnCrossSiteRelativePath

描述： 将传入路径转换为服务器相对路径。 如果页面位于另一页上，则会转移资产并更新 URL。 任何失败都保留为原始值。

              示例：{ServerRelativeFileName} = ReturnCrossSiteRelativePath({ImageLink})

输入参数

名称	说明
{ImageLink}	图像链接的原始值

输出参数

名称	说明
{ServerRelativeFileName}	资产的新目标位置（如果已转移）。

ImageAnchorUrlRewrite

描述： 重写图像定位点标记 URL。

              示例：ImageAnchorUrlRewrite({Anchor},{ImageUrl},{ServerRelativeFileName})

输入参数

名称	说明
{Anchor}	从源图像提取的原始定位标记
{ImageUrl}	原始图像 URL
{ServerRelativeFileName}	新建图像 URL

输出参数

名称	说明
{Anchor}	URL 重写后的 URL。 如果定位点和原始图像 URL 相同，则定位点将设置为新图像 URL

ExtractWebpartProperties

描述： 提取客户端 Web 部件属性，以便可以重复使用它们。

              示例：{JsonProperties} = ExtractWebpartProperties({ClientSideWebPartData})

输入参数

名称	说明
{ClientSideWebPartData}	定义客户端 Web 部件配置的 Web 部件数据

输出参数

名称	说明
{JsonProperties}	用于配置客户端 Web 部件的 Json 属性

DocumentEmbedLookup

描述： 根据给定的服务器相对路径查找文件，并返回该文件的所需属性。 如果未找到文件，则返回 null。

              示例：DocumentEmbedLookup({ServerRelativeFileName})

输入参数

名称	说明
{ServerRelativeFileName}	服务器相对文件名

输出参数

名称	说明
{DocumentListId}	包含文件的列表的 ID
{DocumentUniqueId}	文件的 UniqueId
{DocumentAuthor}	文档作者的用户主体名称
{DocumentAuthorName}	文件作者的名称

ContentEmbedCrossSiteCheck

描述： 链接到.aspx文件时引发异常。

              示例：{Temp} = ContentEmbedCrossSiteCheck({ContentLink})

输入参数

名称	说明
{ContentLink}	链接值（如果已设置）

输出参数

名称	说明
{Temp}	未使用的变量

LoadContentFromFile

描述： 将文件的内容作为字符串加载。

              示例：{FileContents} = LoadContentFromFile({ContentLink})

输入参数

名称	说明
{ContentLink}	要加载的文件的服务器相对 URL

输出参数

名称	说明
{FileContents}	文件的文本内容。 如果未找到文件，则返回空字符串

UserDocumentsToHighlightedContentProperties

描述： 将用户文档 Web 部件数据映射到属性集合中，并为内容汇总提供支持 serverProcessedContent 节点 (= 突出显示的内容) Web 部件

              示例：SiteDocumentsToHighlightedContentProperties()

输出参数

名称	说明
{JsonProperties}	contentrollup (的属性集合 = 突出显示的内容) Web 部件
{SearchablePlainTexts}	要添加到 serverProcessedContent 节点中的 SearchablePlainTexts 节点
{Links}	要添加到 serverProcessedContent 节点中的链接节点
{ImageSources}	要添加到 serverProcessedContent 节点中的 ImageSources 节点

ContentBySearchToHighlightedContentProperties

描述： 通过将 Web 部件数据搜索到属性集合和支持 serverProcessedContent 节点来映射内容汇总 (= 突出显示的内容) Web 部件

              示例：ContentBySearchToHighlightedContentProperties({DataProviderJSON}, {SelectedPropertiesJson}, {ResultsPerPage}, {RenderTemplateId})

输入参数

名称	说明
{DataProviderJson}
{SelectedPropertiesJson}
{ResultsPerPage}
{RenderTemplateId}

输出参数

名称	说明
{JsonProperties}	contentrollup (的属性集合 = 突出显示的内容) Web 部件
{SearchablePlainTexts}	要添加到 serverProcessedContent 节点中的 SearchablePlainTexts 节点
{Links}	要添加到 serverProcessedContent 节点中的链接节点
{ImageSources}	要添加到 serverProcessedContent 节点中的 ImageSources 节点

ContentByQueryToHighlightedContentProperties

描述： 通过查询 Web 部件数据将内容映射到属性集合和支持 serverProcessedContent 节点的内容汇总 (= 突出显示的内容) Web 部件

              示例：ContentByQueryToHighlightedContentProperties({WebUrl},{ListGuid},{ListName},{ServerTemplate},{ContentTypeBeginsWithId},{FilterField1},{Filter1ChainingOperator},{FilterDisplayValue1},{FilterOperator1},{FilterField2},{Filter2ChainingOperator},{FilterDisplayValue2},{FilterOperator2},{FilterField3},{FilterDisplayValue3},{FilterOperator3},{SortBy},{SortByDirection},{GroupBy},{GroupByDirection},{ItemLimit},{DisplayColumns},{DataMappings})

输入参数

名称	说明
{WebUrl}
{ListGuid}
{ListName}
{ServerTemplate}
{ContentTypeBeginsWithId}
{FilterField1}
{Filter1ChainingOperator}
{FilterField1Value}
{FilterOperator1}
{FilterField2}
{Filter2ChainingOperator}
{FilterField2Value}
{FilterOperator2}
{FilterField3}
{FilterField3Value}
{FilterOperator3}
{SortBy}
{SortByDirection}
{GroupBy}
{GroupByDirection}
{ItemLimit}
{DisplayColumns}
{DataMappings}

输出参数

名称	说明
{JsonProperties}	contentrollup (的属性集合 = 突出显示的内容) Web 部件
{SearchablePlainTexts}	要添加到 serverProcessedContent 节点中的 SearchablePlainTexts 节点
{Links}	要添加到 serverProcessedContent 节点中的链接节点
{ImageSources}	要添加到 serverProcessedContent 节点中的 ImageSources 节点

TextCleanUpSummaryLinks

描述： 重写摘要链接 Web 部件 html，以符合客户端文本部件支持的 html。

              示例：{CleanedText} = TextCleanUpSummaryLinks({Text})

输入参数

名称	说明
{Text}	原始 wiki html 内容

输出参数

名称	说明
{CleanedText}	符合客户端文本部件的 Html

SummaryLinksToQuickLinksProperties

描述： 将摘要 Web 部件数据映射到属性集合和支持 quicklinks Web 部件的 serverProcessedContent 节点

              示例：SummaryLinksToQuickLinksProperties({Text},{QuickLinksJsonProperties})

输入参数

名称	说明
{Text}	原始 wiki html 内容
{QuickLinksJsonProperties}	QuickLinks JSON 属性 blob (可选)

输出参数

名称	说明
{JsonProperties}	快速链接 Web 部件的属性集合
{SearchablePlainTexts}	要添加到 serverProcessedContent 节点中的 SearchablePlainTexts 节点
{Links}	要添加到 serverProcessedContent 节点中的链接节点
{ImageSources}	要添加到 serverProcessedContent 节点中的 ImageSources 节点

LookupPerson

描述： 从 UserInfo 列表中查找人员并返回所需的详细信息

              示例：LookupPerson({ContactLoginName})

输入参数

名称	说明
{ContactLoginName}	在 i：0#.f|membership 中查找 (的用户帐户 |joe@contoso.onmicrosoft.com 格式)

输出参数

名称	说明
{PersonName}	用户名
{PersonEmail}	用户的电子邮件
{PersonUPN}	用户的 UPN
{PersonRole}	用户的角色
{PersonDepartment}	用户的部门
{PersonPhone}	用户的电话号码
{PersonSip}	用户的 SIP 地址

EmptyString

描述： 返回空字符串

              示例：EmptyString()

输出参数

名称	说明
{return value}	空字符串

StaticString

描述： 返回作为输入提供的 (静态) 字符串

              示例：StaticString('static string')

输入参数

名称	说明
{'static string'}	静态输入字符串

输出参数

名称	说明
{return value}	作为输入提供的字符串

Prefix

描述： 为输入文本添加另一个文本的前缀。 applyIfContentIsEmpty 参数控制是否还需要在实际内容为空时发生前缀

              示例：Prefix('<H1>Prefix some extra text</H1>', {PublishingPageContent}, 'false')

输入参数

名称	说明
{'prefix string'}	将用作前缀的静态输入字符串
{PublishingPageContent}	要作为前缀的实际发布页 HTML 字段内容
{'static boolean value'}	静态 bool (“true”、“false”) 指示当 {PublishingPageContent} 字段内容为 emty 时是否需要进行前缀

输出参数

名称	说明
{return value}	以提供的前缀值作为前缀的 {PublishingPageContent} 的值

Suffix

描述： 将输入文本后缀为另一个文本。 如果实际内容为空，则 applyIfContentIsEmpty 参数控制是否还需要发生后缀

              示例：Suffix('<H1>Suffix some extra text</H1>', {PublishingPageContent}, 'false')

输入参数

名称	说明
{'suffix string'}	将用作后缀的静态输入字符串
{PublishingPageContent}	要后缀的实际发布页 HTML 字段内容
{'static boolean value'}	静态 bool ('true'，'false') 指示当 {PublishingPageContent} 字段内容为 emty 时是否仍需要进行后缀

输出参数

名称	说明
{return value}	{PublishingPageContent} 的值后缀为提供的后缀值

PrefixAndSuffix

描述： 使用另一个文本对输入文本进行前缀和后缀。 applyIfContentIsEmpty 参数控制当实际内容为空时是否需要发生前缀/后缀

              示例：PrefixAndSuffix('<H1>Prefix some extra text</H1>','<H1>Suffix some extra text</H1>',{PublishingPageContent},'false')

输入参数

名称	说明
{'prefix string'}	将用作前缀的静态输入字符串
{'suffix string'}	将用作后缀的静态输入字符串
{PublishingPageContent}	将实际发布页面 HTML 字段内容设置为前缀/后缀
{'static boolean value'}	静态 bool ('true'，'false') 指示当 {PublishingPageContent} 字段内容为 emty 时是否仍需要进行前缀/后缀

输出参数

名称	说明
{return value}	{PublishingPageContent} 的值以提供的值作为前缀/后缀

ToImageUrl

描述： 返回“发布图像”字段值的服务器相对图像 URL。

              示例：ToImageUrl({PublishingPageImage})

输入参数

名称	说明
{PublishingPageImage}	“发布图像”字段值

输出参数

名称	说明
{return value}	服务器相对映像 URL

ToImageAltText

描述： 返回“发布图像”字段值的图像备用文本。

              示例：ToImageAltText({PublishingPageImage})

输入参数

名称	说明
{PublishingPageImage}	“发布图像”字段值

输出参数

名称	说明
{return value}	图像备用文本

ToImageAnchor

描述： 返回“发布图像”字段值的图像定位点 URL。

              示例：ToImageAnchor({PublishingPageImage})

输入参数

名称	说明
{PublishingPageImage}	“发布图像”字段值

输出参数

名称	说明
{return value}	图像定位点 URL

ToImageCaption

描述： 返回“发布 Html 图像标题”字段的图像标题

              示例：ToImageCaption({PublishingImageCaption})

输入参数

名称	说明
{PublishingImageCaption}	发布 Html 图像标题字段值

输出参数

名称	说明
{return value}	图像标题

ToPreviewImageUrl

描述： 返回页面预览图像 URL。

              示例：ToPreviewImageUrl({PreviewImage})

输入参数

名称	说明
{PreviewImage}	发布图像字段值或包含服务器相对图像路径的字符串

输出参数

名称	说明
{return value}	带格式的预览图像 URL

ToAuthors

描述： 查找传递的用户 ID 的用户信息

              示例：ToAuthors({PublishingContact})

输入参数

名称	说明
{userId}	用户的 id (int)

输出参数

名称	说明
{return value}	描述用户详细信息的格式化 json Blob

DefaultTaxonomyFieldValue

描述： 根据提供的术语 ID 填充分类字段。 可以配置为选择性地覆盖现有值

              示例：DefaultTaxonomyFieldValue({TaxField2},'a65537e8-aa27-4b3a-bad6-f0f61f84b9f7|69524923-a5a0-44d1-b5ec-7f7c6d0ec160','true')

输入参数

名称	说明
{分类字段}	要更新的分类字段
{'term ids split by |'}	要设置的术语 ID 列表，当分类字段配置为接受多个术语时，也可以使用多个值
{'static boolean value'}	静态布尔 ('true'，'false') 指示是否必须设置默认术语值，以防字段已包含术语

输出参数

名称	说明
{return value}	包含设置分类字段所需的术语信息的字符串

选择

TextSelector

描述： 允许选项包括空文本 wiki 文本部件的间隔。

              示例：TextSelector({CleanedText})

输入参数

名称	说明
{CleanedText}	客户端文本部件符合 html (通过 TextCleanup 函数清理)

输出值

名称	说明
Text	如果提供的 Wiki 文本不被视为空，则会输出
间隔	如果提供的 Wiki 文本被视为空，则会输出

ListSelectorListLibrary

描述： 分析列表并返回列表基类型。

              示例：ListSelectorListLibrary({ListId})

输入参数

名称	说明
{ListId}	要使用的列表的 Guid
{ViewXml}	所选视图的定义

输出值

名称	说明
库	列表是文档库
列表	列表是文档列表
问题	该列表是问题列表
TaskList	该列表是一个任务列表
DiscussionBoard	列表是讨论板
调查	列表是一项调查
Undefined	未定义列表基类型

ContentEmbedSelectorSourceType

描述： 分析源类型并返回建议的映射。

              示例：ContentEmbedSelectorSourceType({SourceType})

输入参数

名称	说明
{SourceType}	pageviewerwebpart 中查看的页面的 Sourcetype

输出值

名称	说明
WebPage	嵌入内容是页面
ServerFolderOrFile	嵌入的内容指向服务器文件夹或文件

ContentEmbedSelectorContentLink

描述： 内容编辑器可以通过各种方式进行转换，具体取决于是否使用了链接、使用了何种文件类型、是否使用了脚本...

              示例：ContentEmbedSelectorContentLink({ContentLink}, {Content}, {FileContents}, {UseCommunityScriptEditor})

输入参数

名称	说明
{ContentLink}	链接值（如果已设置）
{Content}	嵌入在 Web 部件中的内容
{FileContents}	文件的文本内容。 如果未找到文件，则返回空字符串
{UseCommunityScriptEditor}	通过 PageTransformationInformation 实例提供的 UseCommunityScriptEditor 映射属性

输出值

名称	说明
链接	如果链接不为空，并且它是 aspx 文件
NonASPXLink	如果链接不为空，并且它不是 aspx 文件，但文件内容确实包含 JavaScript
NonASPXLinkNoScript	如果链接不为空，并且它不是 aspx 文件，并且内容不包含 JavaScript
NonASPXUseCommunityScriptEditor	使用社区脚本编辑器托管内容
内容	如果未指定链接，但内容已嵌入且包含 JavaScript
ContentNoScript	如果未指定链接且嵌入内容且不包含 JavaScript
ContentUseCommunityScriptEditor	使用社区脚本编辑器托管内容

ContentByQuerySelector

描述： 分析列表并返回列表是否可以转换。

              示例：ContentByQuerySelector({ListGuid},{ListName})

输入参数

名称	说明
{ListGuid}	CBQ Web 部件使用的列表的 Guid
{ListName}	CBQ Web 部件使用的列表的名称

输出值

名称	说明
默认值	转换列表
NoTransformation	不转换列表

SummaryLinkSelector

描述： 使用通过 PageTransformationInformation 实例提供的 SummaryLinksToQuickLinks 映射属性来确定映射

              示例：SummaryLinkSelector({SummaryLinksToQuickLinks})

输入参数

名称	说明
{SummaryLinksToQuickLinks}	通过 PageTransformationInformation 实例提供的 SummaryLinksToQuickLinks 映射属性

输出值

名称	说明
UseQuickLinks	转换为 QuickLinks Web 部件
UseText	转换为带格式的文本

ScriptEditorSelector

描述： 使用通过 PageTransformationInformation 实例提供的 UseCommunityScriptEditor 映射属性来确定映射

              示例：ScriptEditorSelector({UseCommunityScriptEditor})

输入参数

名称	说明
{UseCommunityScriptEditor}	通过 PageTransformationInformation 实例提供的 UseCommunityScriptEditor 映射属性

输出值

名称	说明
UseCommunityScriptEditor	转换为社区脚本编辑器 Web 部件
NoScriptEditor	不要转换，因为没有脚本编辑器

UserExistsSelector

描述： 检查传递的值是否为用户

              示例：UserExistsSelector({PersonEmail})

输入参数

名称	说明
{PersonEmail}	用户帐户

输出值

名称	说明
InvalidUser	用户无效
ValidUser	用户信息有效