Skip to content

Commit 71b0bb5

Browse files
ElizabethSamuel-MSFTRick-Kirkham
ElizabethSamuel-MSFT
and
Rick-Kirkham
authored
[Word] [PowerPoint] (json) Update 'Get whole doc' tutorial (#4775)
* [Word] [PowerPoint] (json) Update 'Get whole doc' tutorial * Tag as preview * Update docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md Co-authored-by: Rick Kirkham <[email protected]> * Fix indentation * Update step to save manifest * Fix formatting * Update based on feedback * Update ms.date and remove description field * Update docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md --------- Co-authored-by: Rick Kirkham <[email protected]>
1 parent 0cea566 commit 71b0bb5

File tree

1 file changed

+109
-28
lines changed

1 file changed

+109
-28
lines changed

‎docs/develop/get-the-whole-document-from-an-add-in-for-powerpoint-or-word.md

Lines changed: 109 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Get the whole document from an add-in for PowerPoint or Word
33
description: Learn to get the whole document from a PowerPoint or Word add-in.
4-
ms.date: 01/07/2025
4+
ms.date: 02/12/2025
55
ms.topic: how-to
66
ms.localizationpriority: medium
77
---
@@ -22,7 +22,7 @@ This article assumes that you are using a text editor to create the task pane ad
2222

2323
- A CSS file (**Program.css**) to contain the styles and formatting for the add-in.
2424

25-
- An add-in only manifest file (**GetDoc_App.xml**) for the add-in, available on a shared network folder or add-in catalog. The manifest file must point to the location of the HTML file mentioned previously.
25+
- A manifest file (**GetDoc_App.xml** or **GetDoc_App.json**) for the add-in, available on a shared network folder or add-in catalog. The manifest file must point to the location of the HTML file mentioned previously.
2626

2727
Alternatively, you can create an add-in for your Office application using one of the following options. You won't have to create new files as the equivalent of each required file will be available for you to update. For example, the Yeoman generator options include **./src/taskpane/taskpane.html**, **./src/taskpane/taskpane.js**, **./src/taskpane/taskpane.css**, and **./manifest.xml**.
2828

@@ -41,33 +41,114 @@ Before you begin creating this add-in for PowerPoint or Word, you should be fami
4141

4242
The manifest file for an Office Add-in provides important information about the add-in: what applications can host it, the location of the HTML file, the add-in title and description, and many other characteristics.
4343

44-
1. In a text editor, add the following code to the manifest file.
45-
46-
```xml
47-
<?xml version="1.0" encoding="utf-8" ?>
48-
<OfficeApp xmlns="http://schemas.microsoft.com/office/appforoffice/1.1"
49-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
50-
xsi:type="TaskPaneApp">
51-
<Id>[Replace_With_Your_GUID]</Id>
52-
<Version>1.0</Version>
53-
<ProviderName>[Provider Name]</ProviderName>
54-
<DefaultLocale>EN-US</DefaultLocale>
55-
<DisplayName DefaultValue="Get Doc add-in" />
56-
<Description DefaultValue="My get PowerPoint or Word document add-in." />
57-
<IconUrl DefaultValue="http://officeimg.vo.msecnd.net/_layouts/images/general/office_logo.jpg" />
58-
<SupportUrl DefaultValue="[Insert the URL of a page that provides support information for the app]" />
59-
<Hosts>
60-
<Host Name="Document" />
61-
<Host Name="Presentation" />
62-
</Hosts>
63-
<DefaultSettings>
64-
<SourceLocation DefaultValue="[Network location of app]/GetDoc_App.html" />
65-
</DefaultSettings>
66-
<Permissions>ReadWriteDocument</Permissions>
67-
</OfficeApp>
68-
```
44+
In a text editor, add the following code to the manifest file. If you're using a Visual Studio project, select the "Add-in only manifest" option.
45+
46+
# [Unified manifest for Microsoft 365](#tab/jsonmanifest)
47+
48+
> [!NOTE]
49+
> The unified manifest is generally available for production Outlook add-ins. It's available only for preview in Excel, PowerPoint, and Word add-ins.
50+
51+
```json
52+
{
53+
"$schema": "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json#",
54+
"manifestVersion": "devPreview",
55+
"version": "1.0.0.0",
56+
"id": "[Replace_With_Your_GUID]",
57+
"localizationInfo": {
58+
"defaultLanguageTag": "en-us"
59+
},
60+
"developer": {
61+
"name": "[Provider Name e.g., Contoso]",
62+
"websiteUrl": "[Insert the URL for the app e.g., https://www.contoso.com]",
63+
"privacyUrl": "[Insert the URL of a page that provides privacy information for the app e.g., https://www.contoso.com/privacy]",
64+
"termsOfUseUrl": "[Insert the URL of a page that provides terms of use for the app e.g., https://www.contoso.com/servicesagreement]"
65+
},
66+
"name": {
67+
"short": "Get Doc add-in",
68+
"full": "Get Doc add-in"
69+
},
70+
"description": {
71+
"short": "My get PowerPoint or Word document add-in.",
72+
"full": "My get PowerPoint or Word document add-in."
73+
},
74+
"icons": {
75+
"outline": "_layouts/images/general/office_logo.jpg",
76+
"color": "_layouts/images/general/office_logo.jpg"
77+
},
78+
"accentColor": "#230201",
79+
"validDomains": [
80+
"https://www.contoso.com"
81+
],
82+
"showLoadingIndicator": false,
83+
"isFullScreen": false,
84+
"defaultBlockUntilAdminAction": false,
85+
"authorization": {
86+
"permissions": {
87+
"resourceSpecific": [
88+
{
89+
"name": "Document.ReadWrite.User",
90+
"type": "Delegated"
91+
}
92+
]
93+
}
94+
},
95+
"extensions": [
96+
{
97+
"requirements": {
98+
"scopes": [
99+
"document",
100+
"presentation"
101+
]
102+
},
103+
"alternates": [
104+
{
105+
"alternateIcons": {
106+
"icon": {
107+
"size": 32,
108+
"url": "http://officeimg.vo.msecnd.net/_layouts/images/general/office_logo.jpg"
109+
},
110+
"highResolutionIcon": {
111+
"size": 64,
112+
"url": "http://officeimg.vo.msecnd.net/_layouts/images/general/office_logo.jpg"
113+
}
114+
}
115+
}
116+
]
117+
}
118+
]
119+
}
120+
```
69121

70-
1. Save the file as **GetDoc_App.xml** using UTF-8 encoding to a network location or to an add-in catalog.
122+
# [Add-in only manifest](#tab/xmlmanifest)
123+
124+
```xml
125+
<?xml version="1.0" encoding="utf-8" ?>
126+
<OfficeApp xmlns="http://schemas.microsoft.com/office/appforoffice/1.1"
127+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
128+
xsi:type="TaskPaneApp">
129+
<Id>[Replace_With_Your_GUID]</Id>
130+
<Version>1.0</Version>
131+
<ProviderName>[Provider Name]</ProviderName>
132+
<DefaultLocale>EN-US</DefaultLocale>
133+
<DisplayName DefaultValue="Get Doc add-in" />
134+
<Description DefaultValue="My get PowerPoint or Word document add-in." />
135+
<IconUrl DefaultValue="http://officeimg.vo.msecnd.net/_layouts/images/general/office_logo.jpg" />
136+
<HighResolutionIconUrl DefaultValue="http://officeimg.vo.msecnd.net/_layouts/images/general/office_logo.jpg" />
137+
<SupportUrl DefaultValue="[Insert the URL of a page that provides support information for the app]" />
138+
<Hosts>
139+
<Host Name="Document" />
140+
<Host Name="Presentation" />
141+
</Hosts>
142+
<DefaultSettings>
143+
<SourceLocation DefaultValue="[Network location of app]/GetDoc_App.html" />
144+
</DefaultSettings>
145+
<Permissions>ReadWriteDocument</Permissions>
146+
</OfficeApp>
147+
```
148+
149+
Save the file as **GetDoc_App.xml** using UTF-8 encoding to a network location or to an add-in catalog.
150+
151+
---
71152

72153
## Create the user interface for the add-in
73154

0 commit comments

Comments
 (0)