[APPEXT-878] Editor api docs #9782
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@ester-nl is this content for the 11.1 release? |
|
|
|
||
| ## Introduction | ||
|
|
||
| This how-to describes how to open an existing document editor in Studio Pro from an extension. |
There was a problem hiding this comment.
should probably read: '...document editor in Studio Pro from within an extension'
|
|
||
| This menu action will look for the `Home_Page` document in `MyFirstModule` and it will then open it with the `editor-api`. Of course you can use any module or any document in your app. For more information, please look at the [model api](/apidocs-mxsdk/apidocs/web-extensibility-api-11/model-api/) | ||
|
|
||
| In a listener event called `menuItemActivated`, write the following code. First we look for the page by its name and by the name of its containing module using the `studioPro.app.model.pages` api. |
There was a problem hiding this comment.
Could we swap these sentences around. First explain what you are doing then provide the example with '...write the following code:'
|
|
||
| ## Active Documents | ||
| The editor api also supports notifying the extension when the active document tab gets activated in Studio Pro. It also provides this information on demand, via the `studioPro.ui.editors.getActiveDocument` method. This method returns a `ActiveDocumentInfo` object, which contains the document's name, type, container module name and id. | ||
| To get this `ActiveDocumentInfo` object when the active document changes, you can subscribe to the `activeDocumentChanged`. Add the following code to your extension: |
There was a problem hiding this comment.
You can maybe simply this sentence a bit making it easier to read. Maybe something like: "You can subscrive to the 'activedocumentChanged' event. This will return an 'ActiveDocumentInfo' object whenever the active document changes."
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.