Export (0) Print
Expand All

How to: Update the JavaScript API for Office and manifest schema files in your Visual Studio project from version 1.0 to 1.1

apps for Office

Learn how to update the JavaScript API for Office files (Office.js and app-specific .js files) and app manifest validation file (offappmanifest-1.1.xsd) used in your Visual Studio app for Office project from version 1.0 to version 1.1.

Last modified: December 04, 2014

Applies to: Access app for SharePoint | Excel 2013 | Excel 2013 RT | Excel 2013 SP1 | Excel Online | Outlook 2013 | Outlook 2013 RT | Outlook 2013 SP1 | Outlook for Mac for Office 365 | Outlook Web App | OWA for Devices | PowerPoint 2013 | PowerPoint 2013 RT | PowerPoint 2013 SP1 | PowerPoint Online | Project 2013 | Project 2013 SP1 | Word 2013 | Word 2013 RT | Word 2013 SP1

   Office.js: v1.0, v1.1

   Apps for Office manifests schema: v1.0, v1.1

Note Note

"Outlook" in this article refers to Outlook for Windows, Outlook for Mac, Outlook RT, OWA for Devices (OWA for Android phones, OWA for iPad, OWA for iPhone), and Outlook Web App. At this point, Outlook for Mac supports JavaScript API for Office in only Outlook read mode, and can activate mail apps that reference office.js version 1.0 or 1.1 and use apps for Office schema version 1.0.

In this article
Using the most up-to-date project files
Updating your App for Office Visual Studio project to use the new version 1.1 JavaScript API for Office library and app manifest schema
Additional resources

The App for Office project templates in the initial release of Visual Studio 2013 (download here) contain files for v1.0 of the JavaScript API for Office (Office.js and associated application-specific .js files) and the v1.0 app manifest validation file (offappmanifest.xsd).

To develop your app using the new and updated v1.1 API members of the JavaScript API for Office, and the new v1.1 features of the app manifest (which is validated against offappmanifest-1.1.xsd) you need to download Microsoft Office Developer Tools for Visual Studio 2013 - March 2014 Update.

To run an app developed using the new and updated Office.js v1.1 API and app manifest features, your customers must be running Office 2013 SP1 on-premises products, and where applicable, SharePoint Server 2013 SP1 and related server products, Exchange Server 2013 Service Pack 1 (SP1), or the equivalent online hosted products: Office 365, SharePoint Online, and Exchange Online.

You can find information about downloading the on-premises products here, SharePoint Server 2013 SP1 server products here, and Exchange Server 2013 Service Pack 1 (SP1)here.

For projects created before the release of v1.1 of the JavaScript API for Office and app manifest schema, you can update a project's files using the NuGet Package Manager, and then update your app's HTML pages to reference them.

Note that the update process is applied on a per-project basis – you'll need to repeat the updating process for each app project in which you want to use v1.1 of Office.js and app manifest schema.

Note Note

The v1.1 app manifest schema file itself (offappmanifest-1.1.xsd ) isn't included in your project files, but is installed, by default, in C:\Program Files (x86)\Microsoft Visual Studio 12.0\Xml\Schemas\1033 and added to the XML schema set (specified in the XML Schema dialog box displayed with XML > Schemas) when you install the Microsoft Office Developer Tools for Visual Studio 2013 - March 2014 Update package.

To update the JavaScript API for Office library files in your project to version 1.1

  1. In Visual Studio 2012 or 2013, open or create a new App for Office 2013 project.

  2. Depending on your version of Visual Studio:

    • In Visual Studio 2013, choose Tools > NuGet Package Manager > Manage Nuget Packages for Solution.

    • In Visual Studio 2012. choose Tools > Library Package Manager > Manage Nuget Packages for Solution.

  3. In the Manage NuGet Packages dialog box, in the left pane choose Updates > nuget.org.

  4. In the center pane, select Office JavaScript API in the list, click Update, and then complete the package update process.

  5. In your app's HTML pages, comment out any existing office.js script references (for example: <script src="https://appsforoffice.microsoft.com/lib/1.0/hosted/office.js" type="text/javascript"></script>), and now reference the updated JavaScript API for Office library like this (changing the version value to 1.1):

    <script src="https://appsforoffice.microsoft.com/lib/1.1/hosted/office.js" type="text/javascript"></script>
    

To update the manifest file in your project to use schema version 1.1

  • In your project's app manifest (projectnameManifest.xml) file, update the xmlns attribute of the OfficeApp element changing the version value to 1.1 (leaving the attributes following xmlns unchanged):

    <OfficeApp xmlns="http://schemas.microsoft.com/office/appforoffice/1.1"
    

    Note that after updating the version of the app manifest schema to 1.1, you will need to remove the Capabilities and Capability elements, and replace them with either the Hosts and Host elements or the Requirements and Requirement elements.

Show:
© 2014 Microsoft