适用于: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint Online |SharePoint Server 2013
定义库按钮。
<GalleryButton
Alt="Text"
Command="Text"
CommandPreview="Text"
CommandRevert="Text"
CommandType="General | OptionSelect | IgnoredByMenu"
CommandValueId="Text"
ElementDimensions="Size16by16 | Size32by32 | Size48by48 | Size72by96 | Size96by72 | Size96by96 | Size128by128 | Size190by30 | Size190by40 | Size190by50 | Size190by60"
Id="Text"
Image="Url"
ImageClass="CSS Selector"
ImageLeft="Negative Integer"
ImageTop="Negative Integer"
InnerHTML="HTML"
MenuItemId="Text"
QueryCommand="Text"
Sequence="Integer"
TemplateAlias="Text"
ToolTipImage32by32="Url"
ToolTipImage32by32Class="CSS Selector"
ToolTipImage32by32Left="Negative Integer"
ToolTipImage32by32Top="Negative Integer"
ToolTipTitle="Text"
ToolTipDescription="Text"
ToolTipHelpKeyWord="Text"
ToolTipShortcutKey="Text"
/>
元素和属性
下面各部分介绍了属性、子元素和父元素。
Attributes
属性 | 说明 |
---|---|
Alt |
可选。 用于控件的可选文本。 |
命令 |
可选。 选择控件时要执行的命令的名称。 如果此控件在 CommandUIDefinition 元素中,则此控件的 Command 属性值应该与相应 CommandUIHandler 元素的 Command 属性值相同。 |
CommandPreview |
可选。 预览所选内容时要执行的命令的名称。 |
CommandRevert |
可选。 返回到预览所选内容前所处的状态时要执行的命令的名称。 |
CommandType |
可选。 指定命令类型的枚举值。 常规。 不是特定类型的命令。 OptionSelection。 用户选择选项组中的某个选项时生成的命令。 IgnoredByMenu。 一个命令,用于在选定控件时不应关闭菜单的控件。 |
CommandValueId |
可选。 在选择按钮时随命令事件一起发送的字符串。 |
ElementDimensions |
必填。 一个枚举值,用于指定在其中呈现按钮的矩形的维度。 维度以像素为单位,并采用“宽 X 高”格式。 Size16by16 Size32by32 Size48by48 Size72by96 Size96by72 Size96by96 Size128by128 Size190by30 Size190by40 Size190by50 Size190by60 |
Id |
必填。 标识元素的字符串,例如“buttonStaticStyle1”。 |
图像 |
可选。 文件(包含要用作图标的图像)相对于服务器的 URL。 如果未定义 Image 属性,则必须定义 InnerHTML 属性。 |
ImageClass |
可选。 应用于图像的 CSS 类选择器的名称。 |
ImageLeft |
可选。 一个负整数,表示图像左边缘的偏移。 当 Image 属性指向一个图像文件(其中包含多个图标的图像)时,使用此属性。 |
ImageTop |
可选。 一个负整数,表示图像上边缘的偏移。 当 Image 属性指向一个图像文件(其中包含多个图标的图像)时,使用此属性。 |
InnerHTML |
可选。 阐释按钮所表示的选项的 HTML 标记。 如果未定义 InnerHTML 属性,则必须定义 Image 属性。 |
MenuItemId |
可选。 用于标识按钮所在的菜单项的字符串。 |
QueryCommand |
可选。 轮询状态信息时要执行的命令的名称。 |
Sequence |
可选。 一个指定同级 XML 节点之间的放置顺序的整数。 |
TemplateAlias |
可选。 一个匹配 ControlRef 元素、OverflowArea 元素或 GroupTemplate 元素中的 OverflowSection 元素的 TemplateAlias 属性值的字符串。 在对某个组应用模板时,可使用 TemplateAlias 属性调整该组中控件的大小和位置。 |
ToolTipImage32by32 |
可选。 文件的相对于服务器的 URL,该文件包含要用于工具提示的 32 x 32 像素图像,例如“/_layouts/1033/images/formatmap32x32.png”。 |
ToolTipImage32by32Class |
可选。 应用于工具提示图像的 CSS 选择器的名称。 |
ToolTipImage32by32Left |
可选。 一个负整数,表示图像左边缘的偏移。 当 ToolTipImage32by32 属性指向一个图像文件(其中包含许多图标的图像)时,使用此属性。 ToolTipImage32by32Left 属性的值可用于在创建页面时设置 CSS left 属性。 |
ToolTipImage32by32Top |
可选。 一个负整数,表示图像上边缘的偏移。 当 ToolTipImage32by32 属性指向一个图像文件(其中包含许多图标的图像)时,使用此属性。 ToolTipImage32by32Top 属性的值可用于在创建页面时设置 CSS top 属性。 |
ToolTipTitle |
可选。 显示为工具提示标题的文本。 |
ToolTipDescription |
可选。 显示在工具提示正文中的文本。 |
ToolTipHelpKeyWord |
可选。 上下文相关帮助使用的关键字。 |
ToolTipShortcutKey |
可选。 在工具提示中针对快捷键显示的文本。 例如,如果控件的快捷键为 Alt+J,则此属性的值为“Alt+J”。 工具提示将在工具提示标题后面的括号中显示快捷键的文本:“ (Alt+J) ”。 |
子元素
无
父元素
- CommandUIDefinition
- Controls (Group)
出现次数
- 最小值:0
- 最大值:无限制
示例
以下示例是一个 XML 片段,可定义用于应用格式样式的一组库按钮控件。
<Group
Id="grpStyles"
Description=""
Title="Group Styles"
Template="tmpStyles">
<Controls>
<GalleryButton
Id="buttonStaticStyle1"
Command="ApplyStyle"
QueryCommand="QueryStyle"
InnerHTML="&lt;DIV class=&quot;PreviewStyleContainer&quot;&gt;&lt;P class=&quot;PreviewStaticStyle1&quot; id=&quot;labelPreviewContent0&quot;&gt;&lt;/P&gt;&lt;P class=&quot;PreviewStyleLabel&quot; id=&quot;labelPreviewStyle0&quot;&gt;&lt;/P&gt;&lt;/DIV&gt;"
ElementDimensions="Size64by48"
LabelText="Heading1"
Alt="Heading1"
TemplateAlias="preview1"/>
<GalleryButton
Id="buttonStaticStyle2"
Command="ApplyStyle"
QueryCommand="QueryStyle"
InnerHTML="&lt;DIV class=&quot;PreviewStyleContainer&quot;&gt;&lt;P class=&quot;PreviewStaticStyle2&quot; id=&quot;labelPreviewContent1&quot;&gt;&lt;/P&gt;&lt;P class=&quot;PreviewStyleLabel&quot; id=&quot;labelPreviewStyle1&quot;&gt;&lt;/P&gt;&lt;/DIV&gt;"
ElementDimensions="Size64by48"
LabelText="Heading2"
Alt="Heading2"
TemplateAlias="preview2"/>
<GalleryButton
Id="buttonStaticStyle3"
QueryCommand="QueryStyle"
Command="ApplyStyle"
InnerHTML="&lt;DIV class=&quot;PreviewStyleContainer&quot;&gt;&lt;P class=&quot;PreviewStaticStyle3&quot; id=&quot;labelPreviewContent2&quot;&gt;&lt;/P&gt;&lt;P class=&quot;PreviewStyleLabel&quot; id=&quot;labelPreviewStyle2&quot;&gt;&lt;/P&gt;&lt;/DIV&gt;"
ElementDimensions="Size64by48"
LabelText="Heading3"
Alt="Heading3"
TemplateAlias="preview3"/>
<GalleryButton
Id="buttonStaticStyle4"
Command="ApplyStyle"
QueryCommand="QueryStyle"
InnerHTML="&lt;DIV class=&quot;PreviewStyleContainer&quot;&gt;&lt;P class=&quot;PreviewStaticStyle4&quot; id=&quot;labelPreviewContent3&quot;&gt;&lt;/P&gt;&lt;P class=&quot;PreviewStyleLabel&quot; id=&quot;labelPreviewStyle3&quot;&gt;&lt;/P&gt;&lt;/DIV&gt;"
ElementDimensions="Size64by48"
LabelText="Quote"
Alt="Quote"
TemplateAlias="preview4"/>
<GalleryButton
Id="buttonStaticStyle5"
Command="ApplyStyle"
QueryCommand="QueryStyle"
InnerHTML="&lt;DIV class=&quot;PreviewStyleContainer&quot;&gt;&lt;P class=&quot;PreviewStaticStyle5&quot; id=&quot;labelPreviewContent4&quot;&gt;&lt;/P&gt;&lt;P class=&quot;PreviewStyleLabel&quot; id=&quot;labelPreviewStyle4&quot;&gt;&lt;/P&gt;&lt;/DIV&gt;"
ElementDimensions="Size64by48"
LabelText="Citation"
Alt="Citation"
TemplateAlias="preview5"/>
<FlyoutAnchor
Alt="STR@L_MenuMoreStyles"
Id="fsfaMoreStyles"
Command="MenuOpenEditOnly"
MenuAlt="STR@L_MenuMoreStyles"
LabelText="STR@L_MenuMoreStyles"
Image32by32="IMGMAP@one@UxGalWordQuickFormatsHH"
TemplateAlias="morestyles"
PopulateDynamically="true"
PopulateOnlyOnce="false"
PopulateQueryCommand="PopulateMenuMoreStyles"
CommandMenuClose="MenuClose"
CacheMenuVersions="false">
</FlyoutAnchor>
</Controls>
</Group>