The XML manifest file of an Office Add-in describes how your add-in should be activated when an end user installs and uses it with Office documents and applications.
An XML manifest file based on this schema enables an Office Add-in to do the following:
- Manage your plans and schedules in Microsoft Project as you always do. Import your Project file into the Office Timeline add-in with just a few clicks. Instantly get your timeline and sync to update it automatically as plans change.
- Then, select Office Timeline from the list of disabled add-ins and press the Enable button. Select COM Add-ins in the Manage drop-down list and press Go. In the COM Add-Ins dialog box, check Office Timeline and un-check all other add-ins (you can re-enable them one at a time later). PowerPoint will add Office Timeline to the ribbon.
- Excel for Office 365 Excel for Office 365 for Mac Excel 2019 Excel 2016 Excel 2019 for Mac Excel 2013 Excel 2010 Excel 2007 Excel. To create a Gantt chart like the one in our example that shows task progress in days. And on the Chart Design tab, select Add Chart Element. To select a layout, click Quick Layout. To fine-tune the design.
Describe itself by providing an ID, version, description, display name, and default locale.
Specify the images used for branding the add-in and iconography used for add-in commands in the Office Ribbon.
Specify how the add-in integrates with Office, including any custom UI, such as ribbon buttons the add-in creates.
Specify the requested default dimensions for content add-ins, and requested height for Outlook add-ins.
Declare permissions that the Office Add-in requires, such as reading or writing to the document.
Descargar microsoft publisher para mac gratis. Microsoft publisher for mac free download - Microsoft Virtual PC for Mac 7.0.3 Update, Microsoft Virtual PC for Mac Update, Parallels Desktop for Mac, and many more programs.
For Outlook add-ins, define the rule or rules that specify the context in which they will be activated and interact with a message, appointment, or meeting request item.
Note
MS Project import doesn't work ('file corrupt' error) Wrike import doesn't work. Office 365: PowerPoint freezes or crashes when using Office Timeline. Milestone and task dates set on the same day don’t align properly. Office Timeline 3.17 and higher: Compatibility with older builds.
If you plan to publish your add-in to AppSource and make it available within the Office experience, make sure that you conform to the Commercial marketplace certification policies. For example, to pass validation, your add-in must work across all platforms that support the methods that you define (for more information, see section 1120.3 and the Office Add-in host and availability page).
Tip
If you'll be testing your add-in across multiple environments (for example, in development, staging, demo, etc.), we recommend that you maintain a different XML manifest file for each environment. In each manifest file, you can:
- Specify the URLs that correspond to the environment.
- Customize metadata values like
DisplayNameand labels withinResourcesto indicate the environment, so that end users will be able to identify a sideloaded add-in's corresponding environment. - Customize the custom functions
namespaceto indicate the environment, if your add-in defines custom functions.
By following this guidance, you'll streamline the testing process and avoid issues that would otherwise occur when an add-in is simultaneously sideloaded for multiple environments.
Required elements
The following table specifies the elements that are required for the three types of Office Add-ins.
Note
There is also a mandatory order in which elements must appear within their parent element. For more information see How to find the proper order of manifest elements.
Required elements by Office Add-in type
| Element | Content | Task pane | Outlook |
|---|---|---|---|
| OfficeApp | X | X | X |
| Id | X | X | X |
| Version | X | X | X |
| ProviderName | X | X | X |
| DefaultLocale | X | X | X |
| DisplayName | X | X | X |
| Description | X | X | X |
| IconUrl | X | X | X |
| SupportUrl** | X | X | X |
| DefaultSettings (ContentApp) DefaultSettings (TaskPaneApp) | X | X | |
| SourceLocation (ContentApp) SourceLocation (TaskPaneApp) | X | X | |
| DesktopSettings | X | ||
| SourceLocation (MailApp) | X | ||
| Permissions (ContentApp) Permissions (TaskPaneApp) Permissions (MailApp) | X | X | X |
| Rule (RuleCollection) Rule (MailApp) | X | ||
| Requirements (MailApp)* | X | ||
| Set* Sets (MailAppRequirements)* | X | ||
| Form* FormSettings* | X | ||
| Sets (Requirements)* | X | X | |
| Hosts* | X | X |
*Added in the Office Add-in Manifest Schema version 1.1.
** SupportUrl is only required for add-ins that are distributed through AppSource.
Office Timeline Add In Pro
Hosting requirements
All image URIs, such as those used for add-in commands, must support caching. The server hosting the image should not return a Cache-Control header specifying no-cache, no-store, or similar options in the HTTP response.
All URLs, such as the source file locations specified in the SourceLocation element, should be SSL-secured (HTTPS). While not strictly required in all add-in scenarios, using an HTTPS endpoint for your add-in is strongly recommended. Add-ins that are not SSL-secured (HTTPS) generate unsecure content warnings and errors during use. If you plan to run your add-in in Office on the web or publish your add-in to AppSource, it must be SSL-secured. If your add-in accesses external data and services, it should be SSL-secured to protect data in transit. Self-signed certificates can be used for development and testing, so long as the certificate is trusted on the local machine.
Best practices for submitting to AppSource
Make sure that the add-in ID is a valid and unique GUID. Various GUID generator tools are available on the web that you can use to create a unique GUID.
Add-ins submitted to AppSource must also include the SupportUrl element. For more information, see Validation policies for apps and add-ins submitted to AppSource.
Only use the AppDomains element to specify domains other than the one specified in the SourceLocation element for authentication scenarios.
Specify domains you want to open in the add-in window
When running in Office on the web, your task pane can be navigated to any URL. However, in desktop platforms, if your add-in tries to go to a URL in a domain other than the domain that hosts the start page (as specified in the SourceLocation element of the manifest file), that URL opens in a new browser window outside the add-in pane of the Office host application.
To override this (desktop Office) behavior, specify each domain you want to open in the add-in window in the list of domains specified in the AppDomains element of the manifest file. If the add-in tries to go to a URL in a domain that is in the list, then it opens in the task pane in both Office on the web and desktop. If it tries to go to a URL that isn't in the list, then, in desktop Office, that URL opens in a new browser window (outside the add-in pane).
Note
There are two exceptions to this behavior:
- It applies only to the root pane of the add-in. If there is an iframe embedded in the add-in page, the iframe can be directed to any URL regardless of whether it is listed in AppDomains, even in desktop Office.
- When a dialog is opened with the displayDialogAsync API, the URL that is passed to the method must be in the same domain as the add-in, but the dialog can then be directed to any URL regardless of whether it is listed in AppDomains, even in desktop Office.
The following XML manifest example hosts its main add-in page in the https://www.contoso.com domain as specified in the SourceLocation element. It also specifies the https://www.northwindtraders.com domain in an AppDomain element within the AppDomains element list. If the add-in goes to a page in the www.northwindtraders.com domain, that page opens in the add-in pane, even in Office desktop.
Specify domains from which Office.js API calls are made
Your add-in can make Office.js API calls from the domain referenced in the SourceLocation element of the manifest file. If you have other IFrames within your add-in that need to access Office.js APIs, add the domain of that source URL to the list specified in the AppDomains element of the manifest file. If an IFrame with a source not contained in the AppDomains list attempts to make an Office.js API call, then the add-in will receive a permission denied error.
Manifest v1.1 XML file examples and schemas
The following sections show examples of manifest v1.1 XML files for content, task pane, and Outlook add-ins.
Validate an Office Add-in's manifest
For information about validating a manifest against the XML Schema Definition (XSD), see Validate an Office Add-in's manifest.