OfficeApp element
The root element in the manifest of an Office Add-in.
Add-in type: Content, Task pane, Mail
XML
<OfficeApp
xmlns="http://schemas.microsoft.com/office/appforoffice/1.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type= ["ContentApp" |"MailApp"| "TaskPaneApp"]>
...
</OfficeApp>
None
The <OfficeApp> element must contain the following child elements depending on the add-in type.
Element | Content | TaskPane | |
---|---|---|---|
Id | Yes | Yes | Yes |
Version | Yes | Yes | Yes |
ProviderName | Yes | Yes | Yes |
DefaultLocale | Yes | Yes | Yes |
DefaultSettings | Yes | No | Yes |
DisplayName | Yes | Yes | Yes |
Description | Yes | Yes | Yes |
FormSettings | No | Yes | No |
Permissions | Yes | No | Yes |
Rule | No | Yes | No |
The <OfficeApp> element can contain the following child elements depending on the add-in type.
Element | Content | TaskPane | |
---|---|---|---|
AlternateId | Yes | Yes | Yes |
IconUrl | Yes | Yes | Yes |
HighResolutionIconUrl | Yes | Yes | Yes |
SupportUrl | Yes | Yes | Yes |
AppDomains | Yes | Yes | Yes |
Hosts | Yes | Yes | Yes |
Requirements | Yes | Yes | Yes |
AllowSnapshot | Yes | No | No |
Permissions | No | Yes | No |
DisableEntityHighlighting | No | Yes | No |
Dictionary | No | No | Yes |
VersionOverrides | Yes | Yes | Yes |
ExtendedOverrides | No | No | Yes |
Attribute | Description |
---|---|
xmlns | Defines the Office Add-in manifest namespace and schema version. This attribute should always be set to "http://schemas.microsoft.com/office/appforoffice/1.1" |
xmlns:xsi | Defines the XMLSchema instance. This attribute should always be set to "http://www.w3.org/2001/XMLSchema-instance" |
xsi:type | Defines the kind of Office Add-in. This attribute should be set to one of: "ContentApp" , "MailApp" , or "TaskPaneApp" |
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Office Add-ins feedback
Office Add-ins is an open source project. Select a link to provide feedback: