You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Add prerequisites section instead of just mentioning the menu api familiarity in a sentence below
* Move the wrongly committed part of the introduction from dialogs-api.md to the progress-dialogs.md
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/dialog-api.md
This how-to describes how to open a modal dialog in Studio Pro from an extension, allowing you to display web content.
10
10
11
-
It also covers how to show a progress dialog that follows a sequence of steps and returns a result upon completion.
12
-
13
11
## Prerequisites
14
12
15
13
This how-to uses the results of [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/). Please complete that how-to before starting this one. You should also be familiar with creating menus as described in [Create a Menu Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu-api/).
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/progress-dialogs.md
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,19 @@ title: "Show a Progress Dialog Using Web API"
This how-to describes how to show a progress dialog that follows a sequence of steps and returns a result upon completion.
10
+
11
+
## Prerequisites
12
+
13
+
Before starting this how-to, ensure you have:
14
+
15
+
1. Completed the steps in [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/).
16
+
2. Become familiar with creating menus as described in [Create a Menu Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu-api/).
6
17
7
18
## Showing a Progress Dialog
8
-
First, create a menu that you will use to open the progress dialog.
9
-
10
19
To show a progress dialog, you will need to call the method `studioPro.ui.dialogs.showProgressDialog(<title>, <steps>)`, where:
11
20
12
21
*`<title>` is a string which will be displayed in the title bar of the dialog.
@@ -28,7 +37,7 @@ The `FailedProgressStepResult` object contains the following properties:
28
37
*`stepTitle` - the title of the step that has failed, causing the whole process to fail
29
38
*`error` - a string which describes the error or exception that has occurred during the step execution
30
39
31
-
In this example, we will create a menu to show the modal progress dialog, and run three steps. This is done inside the `loaded` event in the main entry point (`src/main/index.ts`). For more information, see [Create a Menu Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu-api/).
40
+
In this example, we will create a menu to show the modal progress dialog, and run three steps. This is done inside the `loaded` event in the main entry point (`src/main/index.ts`).
0 commit comments