JavaScript API for Office

apps for Office

Last modified: June 04, 2015

Note Note

The name "apps for Office" is changing to "Office Add-ins". During the transition, the documentation and the UI of some Office host applications and Visual Studio tools might still use the term "apps for Office". For details, see New name for apps for Office and SharePoint.

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.

Object

Supported app type

Supported host applications

Appointment

  • Mail app

  • Outlook

AsyncResult

  • Content app

  • Mail app

  • Task pane app

  • Access

  • Excel

  • Outlook

  • PowerPoint

  • Project

  • Word

AttachmentDetails

  • Mail app

  • Outlook

Binding

  • Content app

  • Task pane app

  • Access

  • Excel

  • Word

Bindings

  • Content app

  • Task pane app

  • Access

  • Excel

  • Word

Body

  • Mail app

  • Outlook

Contact

  • Mail app

  • Outlook

Context

  • Content app

  • Mail app

  • Task pane app

  • Access

  • Excel

  • Outlook

  • PowerPoint

  • Project

  • Word

CustomProperties

  • Mail app

  • Outlook

CustomXmlNode

  • Task pane app

  • Word

CustomXmlPart

  • Task pane app

  • Word

CustomXmlParts

  • Task pane app

  • Word

CustomXmlPrefixMappings

  • Task pane app

  • Word

Diagnostics

  • Mail app

  • Outlook

Document

  • Content app

  • Task pane app

  • Access

  • Excel

  • PowerPoint

  • Project

  • Word

EmailAddressDetails

  • Mail app

  • Outlook

EmailUser

  • Mail app

  • Outlook

Entities

  • Mail app

  • Outlook

Error

  • Content app

  • Mail app

  • Task pane app

  • Access

  • Excel

  • Outlook

  • PowerPoint

  • Project

  • Word

File

  • Task pane app

  • PowerPoint

  • Word

Item

  • Mail app

  • Outlook

Location

  • Mail app

  • Outlook

Mailbox

  • Mail app

  • Outlook

MeetingRequest

  • Mail app

  • Outlook

MeetingSuggestion

  • Mail app

  • Outlook

Message

  • Mail app

  • Outlook

MatrixBinding

  • Content app

  • Task pane app

  • Excel

  • Word

MeetingRequest

  • Mail app

  • Outlook

MeetingSuggestion

  • Mail app

  • Outlook

Message

  • Mail app

  • Outlook

Office

  • Content app

  • Mail app

  • Task pane app

  • Access

  • Excel

  • Outlook

  • PowerPoint

  • Project

  • Word

PhoneNumber

  • Mail app

  • Outlook

ProjectDocument

  • Task pane app

  • Project

Recipients

  • Mail app

  • Outlook

RoamingSettings

  • Mail app

  • Outlook

Settings

  • Content app

  • Task pane app

  • Access

  • Excel

  • PowerPoint

  • Word

Slice

  • Task pane app

  • PowerPoint

  • Word

  • Word Online

Subject

  • Mail app

  • Outlook

TableBinding

  • Content app

  • Task pane app

  • Access

  • Excel

  • Word

TableData

  • Content app

  • Task pane app

  • Access

  • Excel

  • Word

TaskSuggestion

  • Mail app

  • Outlook

TextBinding

  • Content app

  • Task pane app

  • Excel

  • Word

Time

  • Mail app

  • Outlook

UserProfile

  • Mail app

  • Outlook

Parent topic

Supported app type

Supported host applications

Enumerations

See child enumeration topics for details.

See Requirements in enumeration topic for details.

To view the JavaScript API for Office organized by the subsets of the API that support each app type, see

API

Description

Shared API

The subset of the API that you can use in all three types of apps for Office: content, task pane, and mail apps.

Document API

The subset of the API that you can use in the two types of apps for Office associated with documents: content and task pane apps.

Mailbox API

The subset of the API that you can use in mail apps.

Supported hosts

  • Access

  • Excel

  • Outlook

  • PowerPoint

  • Project

  • Word

Note Note

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

Library

Office.js

Namespace

Office

Show:
© 2015 Microsoft