Skip to content

[PowerPoint] (Overview) Add article about object model #5213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ElizabethSamuel-MSFT
Copy link
Contributor

No description provided.

Copy link
Contributor

Learn Build status updates of commit f17742f:

✅ Validation status: passed

File Status Preview URL Details
docs/powerpoint/core-concepts.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a new conceptual article on the PowerPoint JavaScript object model and adds it to the PowerPoint TOC.

  • Creates core-concepts.md detailing key PowerPoint object model components.
  • Updates docs/toc.yml to include the new article in the PowerPoint section.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/toc.yml Inserts a new TOC entry for the object model
docs/powerpoint/core-concepts.md Adds a concept article on the PowerPoint object model
Comments suppressed due to low confidence (1)

docs/toc.yml:925

  • Indentation for the new TOC entry doesn’t match existing items. Align it with sibling entries by adding two more spaces before the hyphen.
    - name: PowerPoint object model

Copy link
Contributor

Learn Build status updates of commit a41e157:

✅ Validation status: passed

File Status Preview URL Details
docs/powerpoint/core-concepts.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

Copy link
Member

@davidchesnut davidchesnut left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

couple of suggestions.


While you'll likely use the PowerPoint JavaScript API to develop the majority of functionality in add-ins that target PowerPoint, you'll also use objects in the Common API. For example:

- [Office.Context](/javascript/api/office/office.context): The `Context` object represents the runtime environment of the add-in and provides access to key objects of the API. It consists of presentation configuration details such as `contentLanguage` and `officeTheme` and also provides information about the add-in's runtime environment such as `host` and `platform`. Additionally, it provides the `requirements.isSetSupported()` method, which you can use to check whether a specified requirement set is supported by the PowerPoint application where the add-in is running.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Office.Context](/javascript/api/office/office.context): The `Context` object represents the runtime environment of the add-in and provides access to key objects of the API. It consists of presentation configuration details such as `contentLanguage` and `officeTheme` and also provides information about the add-in's runtime environment such as `host` and `platform`. Additionally, it provides the `requirements.isSetSupported()` method, which you can use to check whether a specified requirement set is supported by the PowerPoint application where the add-in is running.
- [Office.Context](/javascript/api/office/office.context): The `Office.Context` object represents the runtime environment of the add-in and provides access to key objects of the API. It consists of presentation configuration details such as `contentLanguage` and `officeTheme` and also provides information about the add-in's runtime environment such as `host` and `platform`. Additionally, it provides the `requirements.isSetSupported()` method, which you can use to check whether a specified requirement set is supported by the PowerPoint application where the add-in is running.


- **Common APIs**: The [Common API](/javascript/api/office) give access to features such as UI, dialogs, and client settings that are common across multiple Office applications. To learn more about using the Common API, see [Common JavaScript API object model](../develop/office-javascript-api-object-model.md).

While you'll likely use the PowerPoint JavaScript API to develop the majority of functionality in add-ins that target PowerPoint, you'll also use objects in the Common API. For example:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why context and document are shown out of all the things in the Office namespace. Are they more important, or typically used compared to the others? Would be good to have something like "These objects are commonly used..."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants