Host element

Specifies an individual Office application type where the add-in should activate.

Important: The Host element syntax varies depending on whether the element is defined within the basic manifest or within the VersionOverrides node. However, the functionality is the same.

Basic manifest

When defined in the basic manifest (under OfficeApp), the host type is determined by the Name attribute.

Attributes

Attribute Type Required Description
Name string required The name of the type of Office host application.

Name

Specifies the Host type targeted by this add-in. The value must be one of the following:

  • Document (Word)
  • Database (Access)
  • Mailbox (Outlook)
  • Notebook (OneNote)
  • Presentation (PowerPoint)
  • Project (Project)
  • Workbook (Excel)

Example

<Hosts>
    <Host Name="Mailbox">
    </Host>
</Hosts>

VersionOverrides node

When defined in VersionOverrides, the host type is determined by the xsi:type attribute.

Attributes

Attribute Required Description
xsi:type Yes Describes the Office host where these settings apply.

Child elements

Element Required Description
DesktopFormFactor Yes Defines the settings for the desktop form factor.
MobileFormFactor No Defines the settings for the mobile form factor. Note: this element is only supported in Outlook for iOS.
AllFormFactors No Defines the settings for all form factors. Only used by custom functions in Excel.

xsi:type

Controls which Office host (Word, Excel, PowerPoint, Outlook, OneNote) where the contained settings apply. The value must be one of the following:

  • Document (Word)
  • MailHost (Outlook)
  • Notebook (OneNote)
  • Presentation (PowerPoint)
  • Workbook (Excel)

Host example

<Hosts>
    <Host xsi:type="MailHost">
        <!-- Host Settings -->
    </Host>
</Hosts>