What is XML manifest in Office Add-in?

Kapil Panchal - January 01, 2021

Listening is fun too.

Straighten your back and cherish with coffee - PLAY !

play
pause
pause

What is an Office add-in?

The office add-in platform which is used to build application which extends office application and used to interact with the content of office document. Using office add-in, developer can use HTML, CSS, JavaScript to interact with Word, Excel, PowerPoint, Outlook. These applications can run across multiple platforms like Windows, Mac, iPad, and in a browser. Office add-in can do anything which a webpage can do inside a browser.

Figure: Add-in Overview

Using office add-in, developer can do the following things:

Add new functionality to office client:

Using Office add-in, the developer can use external data into the office, add third-party functionality, automate office documents, in-office clients. Example: Microsoft graph API which is used to drives productivity.

Create a new, interactive object which can be embedded in the office document:

Office add-in can provide maps, charts, and provide interactive visualization so that developers can add custom excel sheet and power point presentation.

Office Add-ins XML Manifest

Introduction

The XML manifest file of Office Add-in is used to describe how your add-in should be activated when any user installs and uses it with documents and applications. The manifest file contains referenced URLs where your web application can reside and other resources for add-in like images. The offappmanifest.xsd is used to describe XML schema that is common to office applications like rich client application and their corresponding web client.

Note: Manifest schema version 1.1 must use in office Add-in.

An XML manifest file is based on schema which enables an office-Add-in which is used to do the following things:

The XML file is used to describe itself using Id, Version, and Description display name and default locale.
The XML file is used to specify the location of the HTML which is used to provide the User-Interface of office Add-in.
The XML file is used to specify the requested default dimension for content add-in and also the requested height for outlook add-in.
The XML file is used to define permission used by office add-in for reading or writing purposes.
The XML file is used to display content in the document, in the task pane, or contextually with a message, appointment, or meeting request item.
XML file defines rules which are used to specify the context in which they will be activated or interact using message, appointment, or meeting request item for outlook add-in.

Read More: Office Add-in Development: Vsto Add-ins Vs Javascript Api

Manifest v1.1 XML file examples and schemas

The following example show content, task panel, Outlook, and dictionary office add-in:

In Visual Studio, Visual studio manifest designer is used to office add-in manifest setting rather than manually changing XML. By default Visual studio manifest file is opened in the manifest designer. Using manifest, designer makes it easier to find and reduce data-entry error in the drop-down list box.

Example of Content Office Add-in Manifestv1.1
Content Add-in:

Content office add-in can be directly included in excel or power point and used to add functionality directly into the document. Content add-in provide user interface to run code to edit document or display data from data source.

                                                  


                    01eac144-e55a-45a7-b6e3-f1cc60ab0126
                    en-US\WA123456789
                    1.0.0.0
                    Microsoft
                    en-US
                    
                    
                    
                    
                    
                    
  
                    
                    
                    
    
    
                    
                    
                    400 
                    400
  
                    Restricted
                    true

Figure: Content add-in layout

Example of Task-panel Office Add-in Manifestv1.1 Task panel add-in:

Task panel provide interface which typically display on right-side of window inside word, outlook, PowerPoint. Task panel add-in provide user interface to run code to edit document or emails, display data from data source. Task panel is used when no need to add functionality directly into document.


                                              

                    412ce350-4161-4ad0-a5f5-0ec9d2cd3570
                    1.0.0.0
                    Microsoft
                    en-US
                    
                     
  
                    
                    
  
                    
                    
  
                    
                    http://www.projectlogin.com
                    http://m.projectlogin.com
                    http://www.projectlogin.com.sa
                    http://m.projectlogin.com.sa
  
                    
                    
                    
                    
                    
  
                    
                    
                    
    
  
                    ReadWriteDocument

Task panel add-in layout

Want to hire Trusted Outlook Add-in Development Company? Your Search ends here.

See here

Example of Outlook Office Add-in Manifestv1.1
Outlook office add-in:

Using outlook add-in, developer can use HML, CSS, JavaScript to build an application that can run multiple platform like windows, Mac, and IOS.


  
                    
  
                    971E76EF-D73E-567F-ADAE-5A76B39052CF
                    1.0
                    Microsoft
                    en-us
                    
                    
                    
    
    
    
                    
  
                    
                    
    
                    
                    
                    
      
    
  
                    
                    
          
          
                    
                    216
        
                    
          
          
                    
                    216
        

                    
          
          
                    
        
                    
          
          
                    
        
    
  
                    ReadWriteItem

Conclusion

In this blog, we have discussed the office add-in and manifest file in the office add-in. We have also discussed the example of content, task panel, outlook add-in in the office.

What is XML manifest in Office Add-in? What is an Office add-in? The office add-in platform which is used to build application which extends office application and used to interact with the content of office document. Using office add-in, developer can use HTML, CSS, JavaScript to interact with Word, Excel, PowerPoint, Outlook. These applications can run across multiple platforms like Windows, Mac, iPad, and in a browser. Office add-in can do anything which a webpage can do inside a browser. Figure: Add-in Overview Using office add-in, developer can do the following things: Add new functionality to office client: Using Office add-in, the developer can use external data into the office, add third-party functionality, automate office documents, in-office clients. Example: Microsoft graph API which is used to drives productivity. Create a new, interactive object which can be embedded in the office document: Office add-in can provide maps, charts, and provide interactive visualization so that developers can add custom excel sheet and power point presentation. Office Add-ins XML Manifest Introduction The XML manifest file of Office Add-in is used to describe how your add-in should be activated when any user installs and uses it with documents and applications. The manifest file contains referenced URLs where your web application can reside and other resources for add-in like images. The offappmanifest.xsd is used to describe XML schema that is common to office applications like rich client application and their corresponding web client. Note: Manifest schema version 1.1 must use in office Add-in. An XML manifest file is based on schema which enables an office-Add-in which is used to do the following things: The XML file is used to describe itself using Id, Version, and Description display name and default locale. The XML file is used to specify the location of the HTML which is used to provide the User-Interface of office Add-in. The XML file is used to specify the requested default dimension for content add-in and also the requested height for outlook add-in. The XML file is used to define permission used by office add-in for reading or writing purposes. The XML file is used to display content in the document, in the task pane, or contextually with a message, appointment, or meeting request item. XML file defines rules which are used to specify the context in which they will be activated or interact using message, appointment, or meeting request item for outlook add-in. Read More: Office Add-in Development: Vsto Add-ins Vs Javascript Api Manifest v1.1 XML file examples and schemas The following example show content, task panel, Outlook, and dictionary office add-in: In Visual Studio, Visual studio manifest designer is used to office add-in manifest setting rather than manually changing XML. By default Visual studio manifest file is opened in the manifest designer. Using manifest, designer makes it easier to find and reduce data-entry error in the drop-down list box. Example of Content Office Add-in Manifestv1.1 Content Add-in: Content office add-in can be directly included in excel or power point and used to add functionality directly into the document. Content add-in provide user interface to run code to edit document or display data from data source. 01eac144-e55a-45a7-b6e3-f1cc60ab0126 en-US\WA123456789 1.0.0.0 Microsoft en-US 400 400 Restricted true Figure: Content add-in layout Example of Task-panel Office Add-in Manifestv1.1 Task panel add-in: Task panel provide interface which typically display on right-side of window inside word, outlook, PowerPoint. Task panel add-in provide user interface to run code to edit document or emails, display data from data source. Task panel is used when no need to add functionality directly into document. 412ce350-4161-4ad0-a5f5-0ec9d2cd3570 1.0.0.0 Microsoft en-US http://www.projectlogin.com http://m.projectlogin.com http://www.projectlogin.com.sa http://m.projectlogin.com.sa ReadWriteDocument Task panel add-in layout Want to hire Trusted Outlook Add-in Development Company? Your Search ends here. See here Example of Outlook Office Add-in Manifestv1.1 Outlook office add-in: Using outlook add-in, developer can use HML, CSS, JavaScript to build an application that can run multiple platform like windows, Mac, and IOS. 971E76EF-D73E-567F-ADAE-5A76B39052CF 1.0 Microsoft en-us 216 216 ReadWriteItem Conclusion In this blog, we have discussed the office add-in and manifest file in the office add-in. We have also discussed the example of content, task panel, outlook add-in in the office.

Kapil Panchal

A passionate Technical writer and an SEO freak working as a Content Development Manager at iFour Technolab, USA. With extensive experience in IT, Services, and Product sectors, I relish writing about technology and love sharing exceptional insights on various platforms. I believe in constant learning and am passionate about being better every day.