服务器功能区 XML

项目
06/15/2015

上次修改时间： 2015年3月9日

适用范围： SharePoint Foundation 2010

以下主题介绍服务器功能区 XML 并对用于属性的值进行说明。

服务器功能区 XML 演练

    <CommandUIExtension>
      <CommandUIDefinitions>
        <CommandUIDefinition 
          Location="Ribbon.Tabs._children">
          <Tab 
            Id="Ribbon.CustomTabExample" 
            Sequence="501" 
            Description="My New Tab" 
            Title="My New Tab">

CommandUIDefinition 元素上的 Location 定义其内部控件呈现的位置。在本示例中，您将引用服务器功能区的 Tabs 集合。_children 约定告知功能区将以下 XML 插入到输出中以便呈现功能区。在本例中，您将插入 Tab 元素 XML。Sequence 属性将定义选项卡相对于其他选项卡所呈现的位置。默认选项卡使用 100 的整倍数，因此 Sequence 属性不应是 100 的整倍数以防止出现冲突。应避免冲突，以确保对功能区 XML 进行适当处理。

            <Scaling
              Id="Ribbon.CustomTabExample.Scaling">
              <MaxSize
                Id="Ribbon.CustomTabExample.MaxSize" 
                GroupId="Ribbon.CustomTabExample.CustomGroupExample" 
                Size="OneLargeTwoMedium"/>
              <Scale 
                Id="Ribbon.CustomTabExample.Scaling.CustomTabScaling"
                GroupId="Ribbon.CustomTabExample.CustomGroupExample" 
                Size="OneLargeTwoMedium" />
            </Scaling>

在创建自定义选项卡时，您必须定义在添加控件时如何对选项卡进行缩放。通过将 Scaling 元素与 GroupTemplate 一起使用可对此进行处理。MaxSize 元素对组中控件的最大大小进行定义。而 Scale 元素定义组如何在不同的情况下进行缩放。GroupId 属性将一个组与缩放大小相关联。Size 属性由稍后在本主题中定义的 Layout 元素定义。

            <Groups Id="Ribbon.CustomTabExample.Groups">
              <Group 
                Id="Ribbon.CustomTabExample.CustomGroupExample" 
                Description="This is a custom group!" 
                Title="Custom Group" 
                Sequence="52" 
                Template="Ribbon.Templates.CustomTemplateExample">
                <Controls Id="Ribbon.CustomTabExample.CustomGroupExample.Controls">
                  <Button 
                    Id="Ribbon.CustomTabExample.CustomGroupExample.HelloWorld" 
                    Command="CustomTabExample.HelloWorldCommand" 
                    Sequence="15" 
                    Description="Says Hello to the World!" 
                    LabelText="Hello, World!" 
                    TemplateAlias="cust1"/>

Groups 元素对将在选项卡上出现的组进行定义。Group 元素自身具有与其他控件相似的属性以及一个 Template 属性。Template 属性引用本主题中稍后将要定义的 GroupTemplate。Controls 元素包含将在组中出现的控件。可接受的控件类型在服务器功能区的体系结构中进行定义。组内部的控件必须定义 TemplateAlias 和 Command 属性。与选项卡类似，每个控件具有一个 Sequence 属性，用于定义这些控件将在组中出现的位置。默认控件基于 10 的整倍数，所以任何自定义控件不应使用 10 的整倍数以避免发生冲突。Command 属性由 CommandUIHandler 元素使用，并且即使在未指定 CommandUIHandler 时也要求使用此属性。TemplateAlias 属性定义控件相对于 GroupTemplate 出现的位置。

          <GroupTemplate Id="Ribbon.Templates.CustomTemplateExample">
            <Layout 
              Title="OneLargeTwoMedium" 
              LayoutTitle="OneLargeTwoMedium">
              <Section Alignment="Top" Type="OneRow">
                <Row>
                  <ControlRef DisplayMode="Large" TemplateAlias="cust1" />
                </Row>
              </Section>
              <Section Alignment="Top" Type="TwoRow">
                <Row>
                  <ControlRef DisplayMode="Medium" TemplateAlias="cust2" />
                </Row>
                <Row>
                  <ControlRef DisplayMode="Medium" TemplateAlias="cust3" />
                </Row>
              </Section>
            </Layout>
          </GroupTemplate>

定义组模板时，您必须将其定义为另一个 CommandUIDefinition。CommandUIDefinition 具有 Ribbon.Templates._children 位置。这与用于组和选项卡的模式相同。

GroupTemplate 元素包含一个 Layout 元素，后者又包含 Section 或 OverflowSection 元素。Layout 元素具有一个 Title 属性，可用于 MaxSize 和 Scale 元素上的 Size 属性。

Section 元素具有两个属性。Alignment 属性对以下 Row 元素中的控件所处的位置进行定义。Type 属性定义将在对应的部分显示的行数。一个 Section 最多具有三个 Row 元素。

Row 元素包含一个或多个 ControlRef 元素。每个 ControlRef 元素定义一个控件在功能区的显示方式。DisplayMode 属性包含以下值。

警告
并非所有的控件都提供所有的 DisplayMode 值。

值	说明
Small	显示为无标签文本的小图标。
Medium	显示为带有标签文本的 16 x 16 的图标。
Large	显示为带有标签文本的 32 x 32 的图标。
Text	仅显示为文本。

还可以有一个 OverflowSection 元素而不是 Section 元素。此元素定义一个区域，在此区域中，不必使用 Row 元素即可显示多个控件。所有的控件都将显示为由 DisplayMode 属性定义的相同大小。DividerAfter 和 DividerBefore 属性定义在显示溢出部分时分隔线将出现的位置。

向默认功能区位置添加控件时，您应该考虑组模板和缩放。向默认位置添加控件可改变组的显示。大多数默认组模板包含将随自定义控件一起增长的溢出部分。在更高级的方案中，您可以重写缩放来根据设计需要显示控件。

      <CommandUIHandlers>
        <CommandUIHandler 
          Command="CustomTabExample.HelloWorldCommand" 
          CommandAction="javascript:alert('Hello, world!');" />
        <CommandUIHandler 
          Command="CustomTabExample.GoodbyeWorldCommand" 
          CommandAction="javascript:alert('Good-bye, world!');" />
        <CommandUIHandler 
          Command="CustomTabExample.LoveWorldCommand" 
          CommandAction="javascript:alert('I love you, world!');" />
      </CommandUIHandlers>
    </CommandUIExtension>

CommandUIHandlers 元素包含所有 CommandUIHandler 元素。CommandUIHandler 元素定义功能区上的控件如何响应某个操作。Command 属性是与随控件定义的 Command 属性一起使用的命令的唯一名称。CommandAction 属性包含可对控件执行的操作。此操作可以是 ECMAScript（JavaScript、JScript）、URL 或 UrlAction 元素中以前包含的任意内容。

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="https://schemas.microsoft.com/sharepoint/">
  <CustomAction 
    Id="MyCustomRibbonTab" 
    Location="CommandUI.Ribbon.ListView" 
    RegistrationId="101" 
    RegistrationType="List"> 
    ...
  </CustomAction>
</Elements>

对功能区进行自定义时，您将 CustomAction 元素与功能区 XML 一起使用。有关自定义操作的详细信息，请参阅自定义操作。Location 属性告知 CustomAction 在何处应用自定义项。下表对这些值进行了解释。

值	说明
CommandUI.Ribbon	对于指定的 RegistrationId，自定义项出现在任何地方。
CommandUI.Ribbon.ListView	当存在列表视图 Web 部件时出现自定义项。
CommandUI.Ribbon.EditForm	自定义项出现在编辑表单上。
CommandUI.Ribbon.NewForm	自定义项出现在新建表单上。
CommandUI.Ribbon.DisplayForm	自定义项出现在显示表单上。

请参阅

概念

通过

服务器功能区 XML

服务器功能区 XML 演练

请参阅

概念

其他资源