CustomAction 元素
上次修改时间： 2015年3月9日
适用范围： SharePoint Foundation 2010
本文内容
属性
子元素
父元素
出现次数
定义用户界面扩展，如工具栏上的按钮或网站设置页上的链接。
<CustomAction
RequiredAdmin = "Delegated | Farm | Machine"
ControlAssembly = "Text"
ControlClass = "Text"
ControlSrc = "Text"
Description = "Text"
FeatureId = "Text"
GroupId = "Text"
Id = "Text"
ImageUrl = "Text"
Location = "Text"
RegistrationId = "Text"
RegistrationType = "Text"
RequireSiteAdministrator = "TRUE" | "FALSE"
Rights = "Text"
RootWebOnly = "TRUE" | "FALSE"
ScriptSrc = "Text"
ScriptBlock = "Text"
Sequence = "Integer"
ShowInLists = "TRUE" | "FALSE"
ShowInReadOnlyContentTypes = "TRUE" | "FALSE"
ShowInSealedContentTypes = "TRUE" | "FALSE"
Title = "Text"
UIVersion = "Integer">
</CustomAction>
属性
属性 |
说明 |
|---|---|
RequiredAdmin |
可选属性，类型为 Text。指定应用自定义操作所需的管理权限。此值用于调整管理中心中的链接。可能的值为：
|
ControlAssembly |
可选属性，类型为 Text。指定支持自定义操作的控件的程序集。 |
ControlClass |
可选属性，类型为 Text。指定支持自定义操作的控件类。 |
ControlSrc |
可选属性，类型为 Text。指定用作自定义操作的源的 .ascx 文件的相对 URL，例如，"~/_controltemplates/myCustomAction.ascx"。 |
Description |
可选属性，类型为 Text。将已公开操作的较长描述指定为工具提示或该操作的子描述。 |
FeatureId |
可选属性，类型为 Text。标识与自定义操作相关联的功能。 |
GroupId |
可选属性，类型为 Text。标识包含该操作的操作组（例如，"SiteManagement"）。如果包含在自定义操作组中，则 GroupId 属性的值必须等于 CustomActionGroup 元素的组 ID。 有关 Microsoft SharePoint Foundation 中使用的默认自定义操作组 ID 的列表，请参阅默认自定义操作位置和 ID。 |
Id |
可选属性，类型为 Text。指定自定义操作的唯一标识符。ID 可能是 GUID，也可能是一个特定词语（如 "HtmlViewer"）。 |
ImageUrl |
可选属性，类型为 Text。指定虚拟服务器的相对链接，该链接指向表示项的图标的图像。 |
Location |
可选属性，类型为 Text。指定此自定义操作的位置，例如，"Microsoft.SharePoint.SiteSettings"。 如果 CustomAction 元素包含 CommandUIExtension 子元素，则 Location 必须以"CommandUI.Ribbon"开头。有关用于服务器功能区的默认位置的列表，请参阅默认服务器功能区自定义位置。 如果自定义操作是一个菜单项或工具栏按钮，则可能的选项包括 EditControlBlock、NewFormToolbar、DisplayFormToolbar 和 EditFormToolbar。 如果包含在一个自定义操作组中，则 Location 属性的值必须与 CustomActionGroup 元素的位置相同。 有关 SharePoint Foundation 中使用的默认自定义操作位置的列表，请参阅默认自定义操作位置和 ID。 |
RegistrationId |
可选属性，类型为 Text。指定与此操作关联的列表或项内容类型的标识符，或文件类型或编程标识符 (ProgID)。 |
RegistrationType |
可选属性，类型为 Text。为每项操作指定注册附件。可能的值包括：
|
RequireSiteAdministrator |
可选属性，类型为 Boolean。如果为 TRUE，则指定仅在用户为网站管理员时才显示项；否则为 FALSE。不支持使用与此列表项关联的 SharePoint Foundation 命令的下拉菜单的 RequireSiteAdministrator 属性。 |
Rights |
可选属性，类型为 Text。为使链接可见，需指定一组用户必须具有的权限（例如，"ViewListItems,ManageAlerts"）。如果未指定，则操作始终显示在操作列表中。若要指定多个权限，请用逗号分隔各个值。将根据 AND 逻辑对这组权限进行逻辑分组，这表示用户必须具有指定的所有权限才能看到操作。有关可能的值的列表，请参阅 Microsoft.SharePoint.SPBasePermissions。 |
RootWebOnly |
可选属性，类型为 Boolean。如果为 TRUE，则仅在根网站上部署自定义操作。此属性适用于沙盒解决方案中的自定义操作。 |
ScriptSrc |
可选属性，类型为 Text。指定包含要执行的脚本的文件。仅在 Location 属性设置为 ScriptLink 时，此属性才适用。 |
ScriptBlock |
可选属性，类型为 Text。指定要执行的脚本块。仅在 Location 属性设置为 ScriptLink 时，此属性才适用。 |
Sequence |
可选属性，类型为 Integer。指定操作的排序优先级。 |
ShowInLists |
此属性已弃用，不应该再使用。 可选属性，类型为 Boolean。如果仅在用于管理内容类型的页上显示针对列表的自定义操作，则为 TRUE。默认值为 FALSE。 |
ShowInReadOnlyContentTypes |
可选属性，类型为 Boolean。如果仅在用于管理内容类型的页上显示针对只读内容类型的自定义操作，则为 TRUE；默认值为 FALSE。 |
ShowInSealedContentTypes |
可选属性，类型为 Boolean。如果仅在用于管理内容类型的页上显示针对密封内容类型的自定义操作，则为 TRUE。默认值为 FALSE。 |
Title |
必需属性，类型为 Text。为此操作指定最终用户描述。 |
UIVersion |
可选属性，类型为 Integer。指定应该列出此自定义操作的用户界面的版本。 |
子元素
父元素
出现次数
最小值：1 最大值：无限制 |
备注
您可以使用 CustomAction 元素以自定义操作的形式在工具栏中添加标准 ASP.NET 控件和用户控件（例如，文本框或选项按钮）。但您只能将用于实例化菜单项的控件添加到工具栏的下拉菜单中，且不能添加 Web 部件或任意控件。
示例
下面的示例是替换服务器功能区上的按钮的功能的一部分。
<Elements xmlns="https://schemas.microsoft.com/sharepoint/">
<CustomAction Id="Ribbon.Library.Actions.ReplacementButton"
Location="CommandUI.Ribbon"
RegistrationId="101"
RegistrationType="List"
Title="Replace a Ribbon Button">
<CommandUIExtension>
<CommandUIDefinitions>
<CommandUIDefinition
Location="Ribbon.Library.Actions.ConnectToClient">
<Button Id="Ribbon.Library.Actions.ConnectToClient.ReplacementButton"
Command="ReplacementButtonCommand"
Image16by16="Insert an image URL here."
Image32by32="Insert an image URL here."
LabelText="Replaced Button"
TemplateAlias="o2" />
</CommandUIDefinition>
</CommandUIDefinitions>
<CommandUIHandlers>
<CommandUIHandler
Command="ReplacementButtonCommand"
CommandAction="javascript:alert('This button has been replaced.');" />
</CommandUIHandlers>
</CommandUIExtension>
</CustomAction>
</Elements>