JavaScript API for Office (v1.0)

JavaScript API for Office v1.0

Last modified: June 10, 2014

The JavaScript API for Office includes objects, methods, properties, events, and enumerations that you can use in your apps for Office code.

The Microsoft.Office.WebExtension namespace (which by default is referenced using the alias Office in code) contains objects you can use to write script that interacts with content in Office documents, worksheets, presentations, mail items, and projects from your apps for Office.

Run and edit some JavaScript API for Office code interactively in Excel Online with the API Tutorial for Office.

Use the links below to explore or download maps of the JavaScript API for Office, filtered by app type or host application. Note: Because the mail app type is supported only by Outlook host applications, the same API map is provided for both.

Explore the entire object model:

Explore by app type:

Explore by host application:

Zoom into the JavaScript API for Office model

ZoomIt | download

Zoom into the Office object model for content apps

Content apps

ZoomIt

Zoom into the Office object model for mail apps

Mail apps

ZoomIt

Zoom into the object model for task pane apps

Task pane apps

ZoomIt

Download the set of maps

for each app type and host application.

Zoom into the app object model for Excel

Excel

ZoomIt

Zoom into the app object model for Outllook

Outlook

ZoomIt

Zoom into the app object model for PowerPoint

PowerPoint

ZoomIt

Zoom into the app object model for Project

Project

ZoomIt

Zoom into the app object model for Word

Word

ZoomIt

Object

Supported app type

Supported host applications

Appointment

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

AsyncResult

  • Content app

  • Mail app

  • Task pane app

  • Excel 2013

  • Excel 2013 RT

  • Excel Online

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

  • PowerPoint 2013

  • PowerPoint 2013 RT

  • Project 2013

  • Word 2013

  • Word 2013 RT

AttachmentDetails

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

Binding

  • Content app

  • Task pane app

  • Excel 2013

  • Excel 2013 RT

  • Excel Online

  • Word 2013

  • Word 2013 RT

Bindings

  • Content app

  • Task pane app

  • Excel 2013

  • Excel 2013 RT

  • Excel Online

  • Word 2013

  • Word 2013 RT

Contact

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

Context

  • Content app

  • Mail app

  • Task pane app

  • Excel 2013

  • Excel 2013 RT

  • Excel Online

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

  • PowerPoint 2013

  • PowerPoint 2013 RT

  • Project 2013

  • Word 2013

  • Word 2013 RT

CustomProperties

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

CustomXmlNode

  • Task pane app (Word only)

  • Word 2013

  • Word 2013 RT

CustomXmlPart

  • Task pane app (Word only)

  • Word 2013

  • Word 2013 RT

CustomXmlParts

  • Task pane app (Word only)

  • Word 2013

  • Word 2013 RT

CustomXmlPrefixMappings

  • Task pane app (Word only)

  • Word 2013

  • Word 2013 RT

Document

  • Content app

  • Task pane app

  • Excel 2013

  • Excel 2013 RT

  • Excel Online

  • PowerPoint 2013

  • PowerPoint 2013 RT

  • Project 2013

  • Word 2013

  • Word 2013 RT

EmailAddressDetails

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

EmailUser

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

Entities

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

Error

  • Content app

  • Mail app

  • Task pane app

  • Excel 2013

  • Excel 2013 RT

  • Excel Online

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

  • PowerPoint 2013

  • PowerPoint 2013 RT

  • Project 2013

  • Word 2013

  • Word 2013 RT

File

  • Task pane app

  • PowerPoint 2013

  • PowerPoint 2013 RT

  • Word 2013

  • Word 2013 RT

Item

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

Mailbox

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

MatrixBinding

  • Content app

  • Task pane app

  • Excel 2013

  • Excel 2013 RT

  • Excel Online

  • Word 2013

  • Word 2013 RT

MeetingRequest

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

MeetingSuggestion

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

Message

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

Office

  • Content app

  • Mail app

  • Task pane app

  • Excel 2013

  • Excel 2013 RT

  • Excel Online

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

  • PowerPoint 2013

  • PowerPoint 2013 RT

  • Project 2013

  • Word 2013

  • Word 2013 RT

PhoneNumber

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

ProjectDocument

  • Task pane app (Project only)

  • Project 2013

RoamingSettings

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

Settings

  • Content app

  • Task pane app

  • Excel 2013

  • Excel 2013 RT

  • Excel Online

  • PowerPoint 2013

  • PowerPoint 2013 RT

  • Word 2013

  • Word 2013 RT

Slice

  • Task pane app

  • PowerPoint 2013

  • PowerPoint 2013 RT

  • Word 2013

  • Word 2013 RT

TableBinding

  • Content app

  • Task pane app

  • Excel 2013

  • Excel 2013 RT

  • Excel Online

  • Word 2013

  • Word 2013 RT

TableData

  • Content app

  • Task pane app

  • Excel 2013

  • Excel 2013 RT

  • Excel Online

  • Word 2013

  • Word 2013 RT

TaskSuggestion

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

TextBinding

  • Content app

  • Task pane app

  • Excel 2013

  • Excel 2013 RT

  • Excel Online

  • Word 2013

  • Word 2013 RT

UserProfile

  • Mail app

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

Parent topic

Supported app type

Supported host applications

Enumerations

See child enumeration topics for details.

See Requirements in enumeration topic for details.

The Office.js file provides the core scripting functionality for apps in the Office 2013 applications and instantiates objects in the Project-15.js file. The Project 2013 SDK download also includes Office.js, Project-15.js, and related files for app development, and sample code for task pane apps for Project. For more information, see Task pane apps for Project.

Note Note

For Project 2013, apps use both Office.js and Project-15.js.

Project 2013 does not support the following objects or members in Office.js:

  • Binding object

  • Bindings object

  • The following CoercionType values are not supported for the getSelectedDataAsync method: Html, Matrix, Ooxml, or Table

  • CustomXmlNode object

  • CustomXmlPart object

  • CustomXmlParts object

  • CustomXmlPrefixMappings object

  • Document.SelectionChanged event

  • Document.setSelectedData method

  • Settings object

Supported hosts

  • Excel 2013

  • Excel 2013 RT

  • Excel Online

  • Outlook 2013

  • Outlook 2013 RT

  • Outlook Web App

  • OWA for Devices

  • PowerPoint 2013

  • PowerPoint 2013 RT

  • Project 2013

  • Word 2013

  • Word 2013 RT

See "Supported host applications" in the Objects table for details about support for each object in the JavaScript API for Office.

Library

Office.js

Namespace

Office

Show:
© 2014 Microsoft