CommandUIDefinition 元素

适用于:SharePoint 2016 |SharePoint Foundation 2013 |SharePoint Online |SharePoint Server 2013

包含定义用户界面的元素。

定义

<CommandUIDefinition
  Location = "Text"
 />

元素和属性

下面各部分介绍了属性、子元素和父元素。

Attributes

属性

说明

**位置**

可选 **Text**。 指定此命令的位置。 有关 Microsoft SharePoint Foundation 中使用的默认位置的列表,请参阅 默认服务器功能区自定义 位置。

子元素

Button

CheckBox

ComboBox

ColorPicker

上下文组

上下文选项卡

Controls

DropDown

FlyoutAnchor

GalleryButton

GroupTemplate

Group

InsertTable

Label

MRUSplitButton

MaxSize

菜单

MenuSection

QAT

功能区

小数位数

扩展

缓冲图标

SplitButton

Tab

选项卡

TextBox

ToggleButton

父元素

CommandUIExtension

出现次数

最小值:1

最大值:无限制

示例

以下示例将在文档库中添加一个新的“我的自定义选项卡”选项卡,其中包含一个组和三个按钮。

    <Elements xmlns="http://schemas.microsoft.com/sharepoint/">
      <CustomAction
        Id="MyCustomRibbonTab"
        Location="CommandUI.Ribbon.ListView"
        RegistrationId="101"
        RegistrationType="List">
          <CommandUIExtension>
            <CommandUIDefinitions>
              <CommandUIDefinition
                Location="Ribbon.Tabs._children">
                <Tab
                  Id="Ribbon.CustomTabExample"
                  Title="My Custom Tab"
                  Description="This holds my custom commands!"
                  Sequence="501">
                <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>
                <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"/>
                      <Button
                        Id="Ribbon.CustomTabExample.CustomGroupExample.GoodbyeWorld"
                        Command="CustomTabExample.GoodbyeWorldCommand"
                        Sequence="17"
                        Description="Says good-bye to the World!"
                        LabelText="Good-bye, World!"
                        TemplateAlias="cust2"/>
                      <Button
                        Id="Ribbon.CustomTabExample.CustomGroupExample.LoveWorld"
                        Command="CustomTabExample.LoveWorldCommand"
                        Sequence="19"
                        Description="Says I love the World!"
                        LabelText="I love you, World!"
                        TemplateAlias="cust3"/>
                    </Controls>
                  </Group>
                </Groups>
              </Tab>
            </CommandUIDefinition>
            <CommandUIDefinition Location="Ribbon.Templates._children">
              <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>
          </CommandUIDefinitions>
          <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>
      </CustomAction>
    </Elements>