Elements
link - docs.microsoft.com/en-us/outlook/add-ins/manifests
T = Task Pane, C = Content, M = Mail
| Element | (Manifest Schema) Description |
| AllowSnapshot | (Optional) True or False Whether a snapshot image is saved ( C) |
| AlternateId | (Optional) Specifies the alternate ID issued by the store This element is automatically assigned when you submit your add-in to the store. You do not need to add this element yourself. (T, C, M) |
| AppDomains | (Optional) Used when navigating. If you use ShowTaskPane and have an href link, the domain must be added to this list. AppDomain="https://www.bettersolutions.com" (T, C, M) |
| Capabilities | (removed 1.1 - 2015 September) [Optional] Mailbox, Workbook, Document, Presentation |
| CitationText | |
| DefaultLocale | en-US Specifies the culture name of the locale used by the strings (T, C, M) |
| DefaultSettings | (removed in 1.1 - 2015 September) SourceLocation="https://www.bettersolutions.com/myadd-in" SourceLocation="https://localhost:1234/app/home/home.html" The source location for your add-in. Between 1 and 2018 characters long. (T, C) |
| Description | ExcelTest_Description Used by the store (T, C, M) |
| DesktopSettings | Only Outlook (removed in 1.1 - 2015 September) (M) |
| Dictionary | (Optional) Defines settings that implement additional dictionary support Maximum 250 characters Only Word and Excel (T) DictionaryHomePage |
| DisableEntityHighlighting | Only Outlook False (M) |
| DisplayName | ExcelTest_DisplayName Used by the store (T, C, M) |
| EquivalentAddins | EquivalentAddin |
| ExtendedOverrides | |
| ExtendedPermissions | ExtendedPermission |
| FileName | |
| Form | |
| FormSettings | Only Outlook (added in 1.1 - 2014 March) (removed in 1.1 - 2015 September) ItemType="Message" ItemType="Appointment" (M) |
| HighResolutionIconUrl | (added in 1.1 - 2014 March) [Optional] Image displayed in insertion UX and Office store on high DPI screens DefaultValue = "https://...png" Only Outlook (T, C, M) |
| Hosts | (added in 1.1 - 2014 March) [Optional] Host Name="Mailbox, Workbook, Document, Presentation, Database, Project" (T) |
| IconUrl | (Optional) (Icon) [Required for submission to the store] Appears in the users list of applications DefaultValue = "https://...png" This is required if you publish to the Office Store. (T, C, M) |
| Id | GUID - must be unique for each add-in (T, C, M) |
| Metadata | |
| Methods | The list of javascript API methods that your add-in needs (T, C) Method |
| Namespace | |
| OfficeApp | |
| Override | (Optional) Provides a way to specify the value of a setting for an additional locale. (T, C, M) |
| Permissions | Taskpane and Content Restricted ReadDocument ReadAllDocument WriteDocument ReadWriteDocument [Optional only for Outlook] Restricted ReadItem ReadItemMailbox ReadWriteItem (added in 1.1 - 2014 March) (T, C, M) |
| PhoneSettings | Only Outlook (removed in 1.1 - 2015 September) (M) |
| ProgId | |
| ProviderName | BetterSolutions_ProviderName - Tells the user who created the add-in (T, C, M) |
| QueryUri | |
| RequestedHeight | (added in 1.1 - 2014 March) [Optional] Specifies the initial height of a content add-in in pixels. Between 32 and 1000 Replaces DefaultSettings ( C) |
| RequestedWidth | (added in 1.1 - 2014 March) [Optional] Specifies the initial width of the add-in element in pixels. Between 32 and 1000 Replaces DefaultSettings (T, C, M) |
| Requirements | (added in 1.1 - 2014 March) [Optional but not optional for Outlook] This replaces Capabilities Set=MailBox The minimum set of javascript API requirements that your addin needs. Specifying a requirement set does not limit the available APIs that the add-in can use. If an add-in specifies 1.1 but is running in an Outlook client that supports 1.3 then APIs from 1.3 can be used. (T, C, M) |
| Rule | Only Outlook ItemType="Message" ItemType="Appointment" FormType (added in 1.1 - 2014 March) (M) |
| Sets | Set |
| SourceLocation | |
| SupportUrl | (Optional) www.bettersolutions.com (T, C, M) |
| TabletSettings | Only Outlook (removed in 1.1 - 2014 March) (M) |
| TargetDialects | TargetDialect |
| Title | (added in 1.1 - 2014 March) Max 128 characters (T, C, M) |
| Tokens | Token |
| Version | 1.0.0.0 - Used to track upgrades (T, C, M) |
| VersionOverrides | (Optional) (added in 1.1 - 2015 September) Replaces DefaultSettings Replaces FormSettings (Outlook only) (T, C, M) |
| WebApplicationInfo |
| Element (Manifest Schema) Description |
| AllowSnapshot (Optional) True or False Whether a snapshot image is saved ( C) |
| AlternateId (Optional) Specifies the alternate ID issued by the store This element is automatically assigned when you submit your add-in to the store. You do not need to add this element yourself. (T, C, M) |
| AppDomains (Optional) Used when navigating. If you use ShowTaskPane and have an href link, the domain must be added to this list. AppDomain="https://www.bettersolutions.com" (T, C, M) |
| Capabilities (removed 1.1 - 2015 September) [Optional] Mailbox, Workbook, Document, Presentation |
| CitationText |
| DefaultLocale en-US Specifies the culture name of the locale used by the strings (T, C, M) |
| DefaultSettings (removed in 1.1 - 2015 September) SourceLocation="https://www.bettersolutions.com/myadd-in" SourceLocation="https://localhost:1234/app/home/home.html" The source location for your add-in. Between 1 and 2018 characters long. (T, C) |
| Description ExcelTest_Description Used by the store (T, C, M) |
| DesktopSettings Only Outlook (removed in 1.1 - 2015 September) (M) |
| Dictionary (Optional) Defines settings that implement additional dictionary support Maximum 250 characters Only Word and Excel (T) DictionaryHomePage |
| DisableEntityHighlighting Only Outlook False (M) |
| DisplayName ExcelTest_DisplayName Used by the store (T, C, M) |
| EquivalentAddins EquivalentAddin |
| ExtendedOverrides |
| ExtendedPermissions ExtendedPermission |
| FileName |
| Form |
| FormSettings Only Outlook (added in 1.1 - 2014 March) (removed in 1.1 - 2015 September) ItemType="Message" ItemType="Appointment" (M) |
| HighResolutionIconUrl (added in 1.1 - 2014 March) [Optional] Image displayed in insertion UX and Office store on high DPI screens DefaultValue = "https://...png" Only Outlook (T, C, M) |
| Hosts (added in 1.1 - 2014 March) [Optional] Host Name="Mailbox, Workbook, Document, Presentation, Database, Project" (T) |
| IconUrl (Optional) (Icon) [Required for submission to the store] Appears in the users list of applications DefaultValue = "https://...png" This is required if you publish to the Office Store. (T, C, M) |
| Id GUID - must be unique for each add-in (T, C, M) |
| Metadata |
| Methods The list of javascript API methods that your add-in needs (T, C) Method |
| Namespace |
| OfficeApp |
| Override (Optional) Provides a way to specify the value of a setting for an additional locale. (T, C, M) |
| Permissions Taskpane and Content Restricted ReadDocument ReadAllDocument WriteDocument ReadWriteDocument [Optional only for Outlook] Restricted ReadItem ReadItemMailbox ReadWriteItem (added in 1.1 - 2014 March) (T, C, M) |
| PhoneSettings Only Outlook (removed in 1.1 - 2015 September) (M) |
| ProgId |
| ProviderName BetterSolutions_ProviderName - Tells the user who created the add-in (T, C, M) |
| QueryUri |
| RequestedHeight (added in 1.1 - 2014 March) [Optional] Specifies the initial height of a content add-in in pixels. Between 32 and 1000 Replaces DefaultSettings ( C) |
| RequestedWidth (added in 1.1 - 2014 March) [Optional] Specifies the initial width of the add-in element in pixels. Between 32 and 1000 Replaces DefaultSettings (T, C, M) |
| Requirements (added in 1.1 - 2014 March) [Optional but not optional for Outlook] This replaces Capabilities Set=MailBox The minimum set of javascript API requirements that your addin needs. Specifying a requirement set does not limit the available APIs that the add-in can use. If an add-in specifies 1.1 but is running in an Outlook client that supports 1.3 then APIs from 1.3 can be used. (T, C, M) |
| Rule Only Outlook ItemType="Message" ItemType="Appointment" FormType (added in 1.1 - 2014 March) (M) |
| Sets Set |
| SourceLocation |
| SupportUrl (Optional) www.bettersolutions.com (T, C, M) |
| TabletSettings Only Outlook (removed in 1.1 - 2014 March) (M) |
| TargetDialects TargetDialect |
| Title (added in 1.1 - 2014 March) Max 128 characters (T, C, M) |
| Tokens Token |
| Version 1.0.0.0 - Used to track upgrades (T, C, M) |
| VersionOverrides (Optional) (added in 1.1 - 2015 September) Replaces DefaultSettings Replaces FormSettings (Outlook only) (T, C, M) |
| WebApplicationInfo |
© 2021 Better Solutions Limited. All Rights Reserved. © 2021 Better Solutions Limited TopPrevNext