Skip to content

Commit 0f67249

Browse files
MIchaelMainerMIchaelMainer
committed
Updated landing page for API reference link.
1 parent ca4f1ad commit 0f67249

File tree

1 file changed

+6
-64
lines changed

1 file changed

+6
-64
lines changed

‎reference/javascript-api-for-office.md

Lines changed: 6 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,13 @@
11

22
# JavaScript API for Office
3-
The JavaScript API for Office includes objects, methods, properties, events, and enumerations that you can use in your Office Add-ins code.
4-
5-
Learn more about [supported hosts and other requirements](../docs/overview/requirements-for-running-office-add-ins.md).
6-
7-
The **Microsoft.Office.WebExtension** namespace (which by default is referenced using the alias [Office](../reference/shared/office.md) 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 Office Add-ins.
8-
## JavaScript API for Office objects
9-
10-
11-
|**Object**|**Supported add-in type**|**Supported host applications**|
12-
|:-----|:-----|:-----|
13-
|[AsyncResult](../reference/shared/asyncresult.md)|Content add-in, Outlook add-in, Task pane add-in|Access, Excel, Outlook, PowerPoint, Project, Word|
14-
|[AttachmentDetails](../reference/outlook/simple-types.md)|Outlook add-in|Outlook|
15-
|[Binding](../reference/shared/binding.md)|Content add-in, Task pane add-in|Access, Excel, Word|
16-
|[Bindings](../reference/shared/bindings.bindings.md)|Content add-in, Task pane add-in|Access, Excel, Word|
17-
|[Body](../reference/outlook/Body.md)|Outlook add-in|Outlook|
18-
|[Contact](../reference/outlook/simple-types.md)|Outlook add-in|Outlook|
19-
|[Context](../reference/shared/office.context.md)|Content add-in, Outlook add-in, Task pane add-in |Access, Excel, Outlook, PowerPoint, Project, Word|
20-
|[CustomProperties](../reference/outlook/CustomProperties.md)|Outlook add-in|Outlook|
21-
|[CustomXmlNode](../reference/shared/customxmlnode.customxmlnode.md)|Task pane add-in|Word|
22-
|[CustomXmlPart](../reference/shared/customxmlpart.customxmlpart.md)|Task pane add-in |Word|
23-
|[CustomXmlParts](../reference/shared/customxmlparts.customxmlparts.md)|Task pane add-in |Word|
24-
|[CustomXmlPrefixMappings](../reference/shared/customxmlprefixmappings.customxmlprefixmappings.md)|Task pane add-in |Word|
25-
|[Diagnostics](http://msdn.microsoft.com/library/8ad6a159-ed07-4b82-8897-a80fd208551b%28Office.15%29.aspx)|Outlook add-in|Outlook|
26-
|[Document](../reference/shared/document.md)|Content add-in, Task pane add-in|Access, Excel, PowerPoint, Project, Word|
27-
|[EmailAddressDetails](../reference/outlook/simple-types.md)|Outlook add-in|Outlook|
28-
|[EmailUser](../reference/outlook/simple-types.md)|Outlook add-in|Outlook|
29-
|[Entities](../reference/outlook/simple-types.md)|Outlook add-in|Outlook|
30-
|[Error](../reference/shared/error.md)|Content add-in, Outlook add-in, Task pane add-in|Access, Excel, Outlook, PowerPoint, Project, Word|
31-
|[File](../reference/shared/file.md)|Task pane add-in|PowerPoint, Word|
32-
|[Item](../reference/outlook/Office.context.mailbox.item.md)|Outlook add-in|Outlook|
33-
|[Location](../reference/outlook/Location.md)|Outlook add-in|Outlook|
34-
|[Mailbox](../reference/outlook/Office.context.mailbox.md)|Outlook add-in|Outlook|
35-
|[MeetingSuggestion](../reference/outlook/simple-types.md)|Outlook add-in|Outlook|
36-
|[MatrixBinding](../reference/shared/binding.matrixbinding.md)|Content add-in, Task pane add-in|Excel, Word|
37-
|[MeetingSuggestion](../reference/outlook/simple-types.md)|Outlook add-in|Outlook|
38-
|[Office](../reference/shared/office.md)|Content add-in, Outlook add-in, Task pane add-in|Access, Excel, Outlook, PowerPoint, Project, Word|
39-
|[PhoneNumber](../reference/outlook/simple-types.md)|Outlook add-in|Outlook|
40-
|[ProjectDocument](../reference/shared/projectdocument.projectdocument.md)|Task pane add-in |Project|
41-
|[Recipients](../reference/outlook/Recipients.md)|Outlook add-in|Outlook|
42-
|[RoamingSettings](../reference/outlook/RoamingSettings.md)|Outlook add-in|Outlook|
43-
|[Settings](../reference/shared/document.settings.md)|Content add-in, Task pane add-in|Access, Excel, PowerPoint, Word|
44-
|[Slice](../reference/shared/slice.md)|Task pane add-in|PowerPoint, Word, Word Online|
45-
|[Subject](../reference/outlook/Subject.md)|Outlook add-in|Outlook|
46-
|[TableBinding](../reference/shared/binding.tablebinding.md)|Content add-in, Task pane add-in|Access, Excel, Word|
47-
|[TableData](../reference/shared/tabledata.md)|Content add-in, Task pane add-in|Access, Excel, Word|
48-
|[TaskSuggestion](../reference/outlook/simple-types.md)|Outlook add-in|Outlook|
49-
|[TextBinding](../reference/shared/binding.textbinding.md)|Content add-in, Task pane add-in|Excel, Word|
50-
|[Time](../reference/outlook/Time.md)|Outlook add-in|Outlook|
51-
|[UserProfile](../reference/outlook/Office.context.mailbox.userProfile.md)|Outlook add-in|Outlook|
52-
533

4+
The JavaScript API for Office enables you to create web applications that interact with the object models in Office host applications. Your application will reference the office.js library which is a script loader. office.js loads the object models that are applicable to the Office application that is running the add-in. There are two potential JavaScript object object model forms you may use:
545

6+
1) Common - APIs that were introduced with Office 2013. This is loaded for **all Office host applications** and must be used as it connects your add-in application with the Office client application. The object model contains APIs that are specific to Office clients, and many APIs that are applicable to many Office client host applications. All of the content under [shared](../reference/shared/shared-api.md) and **outlook** are considered the common APIs. The **Microsoft.Office.WebExtension** namespace (which by default is referenced using the alias [Office](../reference/shared/office.md) 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 Office Add-ins. You must use these common APIs if your add-in will target Office 2013 and later. This object model form uses callbacks.
557

56-
## Enumerations
8+
2) Host specific - APIs that were introduced with Office 2016. The new object model that provides host specific strongly-typed objects that correspond to familiar objects that you see when you use Office clients. This is the future of Office JavaScript APIs and should be used moving forward. This is currently applicable to [Word](../reference/word/word-add-ins-javascript-reference.md) and **Excel**. This object model form uses promises.
579

58-
|**Parent topic**|**Supported add-in type**|**Supported host applications**|
59-
|:-----|:-----|:-----|
60-
|[Enumerations](../reference/shared/enumerations.md)|See child enumeration topics for details.|See Requirements in enumeration topic for details.|
61-
62-
## View APIs by add-in type support
63-
64-
To view the JavaScript API for Office organized by the subsets of the API that support each add-in type, see
65-
66-
|**API **|**Description**|
67-
|:-----|:-----|
68-
|[Shared API](../reference/shared/shared-api.md)|The subset of the API that you can use in all three types of Office Add-ins: content, task pane, and Outlook add-ins.|
69-
|[Document API](../reference/shared/document-api.md)|The subset of the API that you can use in the two types of Office Add-ins associated with documents: content and task pane add-ins.|
70-
|[Mailbox API](../reference/outlook/index.md)|The subset of the API that you can use in Outlook add-ins.|
10+
Select the Office client from the dropdown above the TOC to filter the content based on your target host application.
7111

7212
## Supported host applications
7313
* Access
@@ -76,3 +16,5 @@ To view the JavaScript API for Office organized by the subsets of the API that s
7616
* PowerPoint
7717
* Project
7818
* Word
19+
20+
Learn more about [supported hosts and other requirements](../docs/overview/requirements-for-running-office-add-ins.md).

0 commit comments

Comments
 (0)