7 out of 9 rated this helpful - Rate this topic

JavaScript API for Office

apps for Office

Published: February 26, 2013

Class libraries and references

The JavaScript API for Office includes objects, methods, properties, events, and enumerations that can be used in apps for Office created for the Office 2013 versions of Word, Excel, Outlook, PowerPoint, Project Standard, and Project Professional.

The Microsoft.Office.WebExtension namespace (which by default is referenced using the alias Office in code) contains objects that provide functionality for working with apps and content in Office documents, worksheets, presentations, mail items, and projects programmatically. This API reference documents those objects and their members.

Download the JavaScript API for Office wall poster.

Object

Supported app type

Supported host applications

Appointment

  • Mail app

  • Outlook 2013

  • Outlook Web App

AsyncResult

  • Content app

  • Mail app

  • Task pane app

  • Excel 2013

  • Excel Web App

  • Outlook 2013

  • Outlook Web App

  • PowerPoint 2013

  • Project 2013

  • Word 2013

AttachmentDetails

  • Mail app

  • Outlook Web App

Binding

  • Content app

  • Task pane app

  • Excel 2013

  • Excel Web App

  • Word 2013

Bindings

  • Content app

  • Task pane app

  • Excel 2013

  • Excel Web App

  • Word 2013

Contact

  • Mail app

  • Outlook 2013

  • Outlook Web App

Context

  • Content app

  • Mail app

  • Task pane app

  • Excel 2013

  • Excel Web App

  • Outlook 2013

  • Outlook Web App

  • PowerPoint 2013

  • Project 2013

  • Word 2013

CustomProperties

  • Mail app

  • Outlook 2013

  • Outlook Web App

CustomXmlNode

  • Task pane app (Word only)

  • Word 2013

CustomXmlPart

  • Task pane app (Word only)

  • Word 2013

CustomXmlParts

  • Task pane app (Word only)

  • Word 2013

CustomXmlPrefixMappings

  • Task pane app (Word only)

  • Word 2013

Document

  • Content app

  • Task pane app

  • Excel 2013

  • Excel Web App

  • PowerPoint 2013

  • Project 2013

  • Word 2013

EmailAddressDetails

  • Mail app

  • Outlook 2013

  • Outlook Web App

EmailUser

  • Mail app

  • Outlook 2013

  • Outlook Web App

Entities

  • Mail app

  • Outlook 2013

  • Outlook Web App

Error

  • Content app

  • Mail app

  • Task pane app

  • Excel 2013

  • Excel Web App

  • Outlook 2013

  • Outlook Web App

  • PowerPoint 2013

  • Project 2013

  • Word 2013

File

  • Task pane app

  • PowerPoint 2013

  • Word 2013

Item

  • Mail app

  • Outlook 2013

  • Outlook Web App

Mailbox

  • Mail app

  • Outlook 2013

  • Outlook Web App

MatrixBinding

  • Content app

  • Task pane app

  • Excel 2013

  • Excel Web App

  • Word 2013

MeetingRequest

  • Mail app

  • Outlook 2013

  • Outlook Web App

MeetingSuggestion

  • Mail app

  • Outlook 2013

  • Outlook Web App

Message

  • Mail app

  • Outlook 2013

  • Outlook Web App

Office

  • Content app

  • Mail app

  • Task pane app

  • Excel 2013

  • Excel Web App

  • Outlook 2013

  • Outlook Web App

  • PowerPoint 2013

  • Project 2013

  • Word 2013

PhoneNumber

  • Mail app

  • Outlook 2013

  • Outlook Web App

ProjectDocument

  • Task pane app (Project only)

  • Project 2013

RoamingSettings

  • Mail app

  • Outlook 2013

  • Outlook Web App

Settings

  • Content app

  • Task pane app

  • Excel 2013

  • Excel Web App

  • PowerPoint 2013

  • Word 2013

Slice

  • Task pane app

  • PowerPoint 2013

  • Word 2013

TableBinding

  • Content app

  • Task pane app

  • Excel 2013

  • Excel Web App

  • Word 2013

TableData

  • Content app

  • Task pane app

  • Excel 2013

  • Excel Web App

  • Word 2013

TaskSuggestion

  • Mail app

  • Outlook 2013

  • Outlook Web App

TextBinding

  • Content app

  • Task pane app

  • Excel 2013

  • Excel Web App

  • Word 2013

UserProfile

  • Mail app

  • Outlook 2013

  • Outlook Web App

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 clients

  • Excel 2013

  • Excel Web App

  • Outlook 2013

  • Outlook Web App

  • PowerPoint 2013

  • Project 2013

  • Word 2013

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

Did you find this helpful?
(1500 characters remaining)

Community Additions

ADD
© 2013 Microsoft. All rights reserved.