Edit

Group element

  • Article

Defines a group of UI controls in a tab. On custom tabs, the add-in can create multiple groups. Add-ins are limited to one custom tab.

Add-in type: Task pane, Mail

Valid only in these VersionOverrides schemas:

  • Task pane 1.0
  • Mail 1.0
  • Mail 1.1

For more information, see Version overrides in the manifest.

Associated with these requirement sets:

Attributes

Attribute Required Description
id Yes A unique ID for the group.

id attribute

Required. Unique identifier for the group. It is a string with a maximum of 125 characters. This must be unique across all Group elements in the manifest.

Child elements

Element Required Description
Label Yes The label for a group.
Icon Yes The image for a group. Not supported in Outlook add-ins.
Control No Represents a Control object. Can be zero or more.
OfficeControl No Represents one of the built-in Office controls. Can be zero or more. Supported only in PowerPoint add-ins.
OverriddenByRibbonApi No Specifies whether the group should appear on application and platform combinations that support custom contextual tabs. Not supported in Outlook add-ins.

Label

Required. The label of the group. The resid attribute can be no more than 32 characters and must be set to the value of the id attribute of a <String> element in the <ShortStrings> element in the Resources element.

Icon

Required. If a tab contains a lot of groups and the program window is resized, the specified image may display instead.

Note

This child element is not supported in Outlook add-ins.

Control

Optional, but if not present there must be at least one <OfficeControl>. For details about the types of controls that are supported, see the Control element. The order of <Control> and <OfficeControl> in the manifest is interchangeable and they can be intermingled if there are multiple elements, but all must be below the <Icon> element.

<Group id="Contoso.CustomTab1.group1">
    <Label resid="CustomTabGroupLabel"/>
    <Icon>
        <bt:Image size="16" resid="blue-icon-16" />
        <bt:Image size="32" resid="blue-icon-32" />
        <bt:Image size="80" resid="blue-icon-80" />
    </Icon>
    <Control xsi:type="Button" id="Contoso.Button1">
        <!-- information on the control -->
    </Control>
    <!-- other controls, as needed -->
</Group>

OfficeControl

Optional, but if not present there must be at least one <Control>. Include one or more built-in Office controls in the group with <OfficeControl> elements. The id attribute specifies the ID of the built-in Office control. To find the ID of a control, see Find the IDs of controls and control groups. The order of <Control> and <OfficeControl> in the manifest is interchangeable and they can be intermingled if there are multiple elements, but all must be below the <Icon> element.

Add-in type: Task pane

Valid only in these VersionOverrides schemas:

  • Task pane 1.0

For more information, see Version overrides in the manifest.

Associated with these requirement sets:

Note

This child element is supported only in PowerPoint add-ins.

<Group id="Contoso.CustomTab2.group2">
    <Label resid="CustomTabGroupLabel"/>
    <Icon>
        <bt:Image size="16" resid="blue-icon-16" />
        <bt:Image size="32" resid="blue-icon-32" />
        <bt:Image size="80" resid="blue-icon-80" />
    </Icon>
    <Control xsi:type="Button" id="Contoso.Button2">
        <!-- information on the control -->
    </Control>
    <OfficeControl id="Superscript" />
    <!-- other controls, as needed -->
</Group>

OverriddenByRibbonApi

Optional (boolean). Specifies whether the <Group> will be hidden on application and platform combinations that support an API that installs a custom contextual tab on the ribbon at runtime. The default value, if not present, is false. If used, <OverriddenByRibbonApi> must be the first child of <Group>. For more information, see OverriddenByRibbonApi.

Note

This child element is not supported in Outlook add-ins.

<ExtensionPoint xsi:type="PrimaryCommandSurface">
  <CustomTab id="Contoso.CustomTab">
    <Group id="Contoso.CustomTab.group1">
      <OverriddenByRibbonApi>true</OverriddenByRibbonApi>
      <!-- other child elements of the group -->
    </Group>
    <Label resid="customTabLabel"/>
  </CustomTab>
</ExtensionPoint>