Skip to content

Commit dd8bdc6

Browse files
Merge branch 'development' into azure-listContainers
2 parents 0177e28 + 85fb3e3 commit dd8bdc6

File tree

277 files changed

+4035
-1507
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

277 files changed

+4035
-1507
lines changed

config/_default/hugo.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,9 @@ replacements = "github.com/FortAwesome/Font-Awesome -> ., github.com/twbs/bootst
157157
footer_about_disable = true
158158
# NK - set sidebar to be foldable
159159
sidebar_menu_foldable = true
160-
160+
# MvM - don't truncate sidebar tree items: see https://github.com/google/docsy/issues/1026
161+
sidebar_menu_truncate = 100
162+
161163
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
162164
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
163165
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,

content/en/docs/apidocs-mxsdk/apidocs/apps/app-repository-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 10
88

99
## Introduction
1010

11-
The App Repository API enables retrieving information (branches, commits) of application models stored in our [Team Server](/developerportal/general/team-server/).
11+
The App Repository API enables retrieving information (branches, commits) of application models stored in our [Team Server](/developerportal/repository/team-server/).
1212

1313
## Base URL
1414

@@ -107,7 +107,7 @@ Returns information about the version control repository for a Mendix app.
107107

108108
|Name|Type|Required|Description|
109109
|---|---|---|---|
110-
|`AppId`|String|Yes|The App ID of the Mendix app for which the repository information should be returned. You can find this under **Project ID** in the [General](/developerportal/collaborate/general-settings/) tab of the **Settings** page after you open your app in [Apps](https://sprintr.home.mendix.com/). |
110+
|`AppId`|String|Yes|The App ID of the Mendix app for which the repository information should be returned. You can find this under **Project ID** in the [General](/developerportal/general-settings/) tab of the **Settings** page after you open your app in [Apps](https://sprintr.home.mendix.com/). |
111111

112112
##### Example
113113

content/en/docs/apidocs-mxsdk/apidocs/deployment/pipelines-api.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,8 @@ Authorization: MxToken 7LJE…vk
3636

3737
## API Reference{#api-reference}
3838

39-
{{< swaggerui src="/openapi-spec/pipelines.yaml" >}}
39+
{{% alert color="warning" %}}
40+
You cannot call endpoints from the Mendix Pipelines API Swagger UI.
41+
{{% /alert %}}
42+
43+
{{< swaggerui-disable-try-it-out src="/openapi-spec/pipelines.yaml" >}}

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/csharp/_index.md

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ linktitle: "C# Extensibility API"
44
url: /apidocs-mxsdk/apidocs/csharp-extensibility-api-11/
55
description: "The C# extensibility API allows your custom Studio Pro extensions developed in C# to interact with some internal services of Studio Pro."
66
weight: 10
7-
no_list: false
8-
description_list: true
97
aliases:
108
- /apidocs-mxsdk/apidocs/extensibility-api/
119
---
@@ -20,46 +18,53 @@ For information on new releases of the Extensibility API, see [Extensibility: C#
2018

2119
## Introduction
2220

23-
Extensions can be written in C#, described here, or using a web API which is documented separately in [Extensibility API for Web Developers](/apidocs-mxsdk/apidocs/web-extensibility-api-11/).
21+
Extensions can be written in C#, described here, or using a web API (for more information about the Web API, see [Extensibility API for Web Developers](/apidocs-mxsdk/apidocs/web-extensibility-api-11/)).
2422

25-
If you need to add your own custom UI to Studio Pro, you can achieve this using web technology. Your web-based UI will be rendered in Studio Pro using a hosted web view, the API provides communication functionality between your web UI and the C# extension logic.
23+
To add a custom UI to Studio Pro, you can use web technology. Your web-based UI will be rendered in Studio Pro through a hosted web view, and the API provides communication between your UI and the C# extension logic.
2624

2725
## Prerequisites
2826

29-
* You need at least a basic understanding of the Mendix platform.
30-
* You need some understanding of the Mendix Model.
31-
* You need to have some C# development experience. Extensions are developed using [C#](https://docs.microsoft.com/en-us/dotnet/), and compiled into a `.dll` assembly file.
27+
To use the C# API, you must have:
28+
29+
* A basic understanding of the Mendix platform
30+
* Some understanding of the Mendix Model
31+
* Come C# development experience
32+
33+
Extensions are developed using [C#](https://docs.microsoft.com/en-us/dotnet/) and compiled into a `.dll` assembly file.
3234

3335
## Getting Started
3436

35-
For detailed explanation on how to get started with extensions, check out [Get Started with the Extensibility API](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/get-started/).
37+
For detailed information on how to get started with extensions, see [Get Started with the Extensibility API](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/get-started/).
3638

37-
You can also check out our examples and [API reference documentation](https://github.com/mendix/ExtensionAPI-Samples).
39+
You can also review some examples and [API reference documentation](https://github.com/mendix/ExtensionAPI-Samples).
3840

3941
## How-tos
4042

4143
Here is a list of how-tos for you to begin with:
4244

43-
* [How to Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/)
44-
* [How to Create a Dockable Pane Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-dockable-pane-extension/)
45-
* [How to Create a Context Menu Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-context-menu/)
46-
* [How to Create a Web View Hosted Inside a Modal Dialog Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-modal-web-view/)
47-
* [How to Create Microflows for Calculations Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-microflows-for-calculations/)
45+
* [How to Create a Menu Extension](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/)
46+
* [How to Create a Dockable Pane Extension](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-dockable-pane-extension/)
47+
* [How to Create a Context Menu](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-context-menu/)
48+
* [How to Create a Web View Hosted Inside a Modal Dialog](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-modal-web-view/)
49+
* [How to Create Microflows for Calculations](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-microflows-for-calculations/)
50+
* [How to Interact with the Model API](/apidocs-mxsdk/apidocs/interact-with-model-api-11/)
51+
* [How to Create a Microflow and Add Activities](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-microflow-add-activities/)
52+
* [How to Add Menus and Sub-menus](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/add-menu/)
53+
* [How to Build a To-do Example Extension](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/build-todo-example-extension/)
54+
* [How to Export a C# Extension](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/export-an-extension/)
4855

4956
## Advanced APIs
5057

51-
APIs for the Mendix platform's advanced users:
58+
Below are APIs for advanced users:
5259

5360
* [Use the Untyped Model Access API Using C#](/apidocs-mxsdk/apidocs/untyped-model-access-api-11/)
5461

55-
## Learn More
62+
## Reference Guide
63+
64+
Review the following reference guides to explore additional Extensibility API topics:
5665

57-
You can dive into the following topics in depth:
66+
* [Extension Points](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/extension-points/)
67+
* [Extensibility Services](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/services/)
68+
* [Extensibility Web Views](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/web-views/)
5869

59-
* [What are extension points](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/extension-points/)
60-
* [What are the Extensibility API services](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/services/)
61-
* [How to Interact with the Model API Using C#](/apidocs-mxsdk/apidocs/interact-with-model-api-11/)
62-
* [How to host web content via a web view wrapper](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/web-views/)
63-
* [How to Build a Todo Example Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/build-todo-example-extension/)
6470

65-
## Documentation in This Category

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/csharp/extensibility-api-howtos/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ description_list: true
99

1010
## Introduction
1111

12-
The following how-tos teach you how to use the Extensibility API for C# Developers in different use cases.
12+
The following how-tos describe how to use the C# Extensibility API in different use cases.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/csharp/extensibility-api-howtos/add-menu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Add Menus and Submenus to Studio Pro Using C#"
2+
title: "Add Menus and Sub-menus to Studio Pro Using C#"
33
linktitle: "Structured Menus"
44
url: /apidocs-mxsdk/apidocs/csharp-extensibility-api-11/add-menu/
55
weight: 15

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/csharp/extensibility-api-reference-guide/_index.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,4 @@ description_list: true
99

1010
## Introduction
1111

12-
In the **Reference Guide**, you can explore a variety of topics related to the Extensibility API in detail.
13-
14-
### Documentation in This Category
15-
16-
The **Reference Guide** category contains the following documents:
12+
In the following Reference Guide documents, you can explore a variety of topics related to the C# Extensibility API:

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/csharp/extensibility-api-reference-guide/extension-points.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,34 +7,31 @@ weight: 9
77

88
## Introduction
99

10-
Extension points allow you to hook functionality into various areas of the Studio Pro IDE. Extension point is a base class that you as an extension developer can inherit from. Your functionality will then be loaded by Studio Pro. These classes all have the `*Extension` suffix, inherit from [`ExtensionBase`](https://github.com/mendix/ExtensionAPI-Samples/blob/main/API%20Reference/Mendix.StudioPro.ExtensionsAPI/ExtensionBase.md) base class, and contain a few virtual or abstract members.
10+
Extension points allow you to hook functionality into various areas of the Studio Pro IDE. `ExtensionPoint` is a base class that extension developers can inherit from. Once inherited, your functionality will be loaded by Studio Pro. These classes all have the `*Extension` suffix, inherit from the [`ExtensionBase`](https://github.com/mendix/ExtensionAPI-Samples/blob/main/API%20Reference/Mendix.StudioPro.ExtensionsAPI/ExtensionBase.md) base class, and include a few virtual or abstract members.
1111

12-
Extension point is the only way you can add a custom behavior to Studio Pro. The rest of the APIs are there only to aid with implementing or expressing these behaviors.
12+
`ExtensionPoint` is the only way to add custom behavior to Studio Pro. All other APIs provided solely to support the implementation or expression of these behaviors.
1313

14-
To be injected, your class must be decorated with [ExportAttribute](https://docs.microsoft.com/en-us/dotnet/api/system.composition.exportattribute?view=dotnet-plat-ext-6.0)
15-
like in the example above. This attribute is part of [Managed Extensibility Framework](https://docs.microsoft.com/en-us/dotnet/framework/mef/)
16-
that is employed by Studio Pro.
14+
To be injected, your class must be decorated with the [ExportAttribute](https://docs.microsoft.com/en-us/dotnet/api/system.composition.exportattribute?view=dotnet-plat-ext-6.0),
15+
as shown in the example above. This attribute is part of the [Managed Extensibility Framework](https://docs.microsoft.com/en-us/dotnet/framework/mef/) that is used by Studio Pro.
1716

1817
## List of Available Extension Points
1918

2019
### Studio Pro UI Extensions
2120

22-
* [ContextMenuExtension](https://github.com/mendix/ExtensionAPI-Samples/blob/main/API%20Reference/Mendix.StudioPro.ExtensionsAPI.UI.Menu/ContextMenuExtension-1.md) – This allows injecting new context menu items into model elements.
23-
24-
* [MenuExtension](https://github.com/mendix/ExtensionAPI-Samples/blob/main/API%20Reference/Mendix.StudioPro.ExtensionsAPI.UI.Menu/MenuExtension.md) – This allows injecting new menu items into Studio Pro menu bar.
25-
21+
* [ContextMenuExtension](https://github.com/mendix/ExtensionAPI-Samples/blob/main/API%20Reference/Mendix.StudioPro.ExtensionsAPI.UI.Menu/ContextMenuExtension-1.md) – allows injecting new context menu items into model elements
22+
* [MenuExtension](https://github.com/mendix/ExtensionAPI-Samples/blob/main/API%20Reference/Mendix.StudioPro.ExtensionsAPI.UI.Menu/MenuExtension.md) – allows injecting new menu items into the Studio Pro menu bar
2623
* [DockablePaneExtension](https://github.com/mendix/ExtensionAPI-Samples/blob/main/API%20Reference/Mendix.StudioPro.ExtensionsAPI.UI.DockablePane/DockablePaneExtension.md) – allows introducing new
27-
[dockable pane](/refguide/studio-pro-overview/#panes) like Connector or Documentation. Panes integrate with Studio Pro
24+
[dockable pane](/refguide/studio-pro-overview/#panes), like Connector or Documentation; panes integrate with Studio Pro
2825
[layout system](/refguide/view-menu/#layout-of-panes) automatically.
2926

30-
{{% alert color="info" %}}It is advised to introduce a new **View** menu item for each pane, so that Studio Pro users have a way to open it.{{% /alert %}}
27+
{{% alert color="info" %}}It is advised to introduce a new **View** menu item for each pane so Studio Pro users have a way to open it.{{% /alert %}}
3128

32-
Additionally, there are additional features that provide access to the following:
29+
There are additional features that provide access to the following:
3330

3431
* [Studio Pro configuration](https://github.com/mendix/ExtensionAPI-Samples/blob/main/API%20Reference/Mendix.StudioPro.ExtensionsAPI/ExtensionBase/Configuration.md)
3532
* [The currently opened app](https://github.com/mendix/ExtensionAPI-Samples/blob/main/API%20Reference/Mendix.StudioPro.ExtensionsAPI.UI/UIExtensionBase/CurrentApp.md), as well as event subscription mechanism to that app
36-
* Events can be subscribed to by using the subscribe and unsubscribe methods exposed in [UIExtensionBase](https://github.com/mendix/ExtensionAPI-Samples/blob/main/API%20Reference/Mendix.StudioPro.ExtensionsAPI.UI/UIExtensionBase.md).
33+
* Events can be subscribed to by using the subscribe and unsubscribe methods exposed in [UIExtensionBase](https://github.com/mendix/ExtensionAPI-Samples/blob/main/API%20Reference/Mendix.StudioPro.ExtensionsAPI.UI/UIExtensionBase.md)
3734

3835
### Studio Pro and MxBuild Extensions
3936

40-
* [ConsistencyCheckExtension](https://github.com/mendix/ExtensionAPI-Samples/blob/main/API%20Reference/Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck/ConsistencyCheckExtension-1.md)This allows injecting custom logic into the [Consistency check](/refguide/consistency-errors/) process.
37+
* [ConsistencyCheckExtension](https://github.com/mendix/ExtensionAPI-Samples/blob/main/API%20Reference/Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck/ConsistencyCheckExtension-1.md) – allows injecting custom logic into the [Consistency check](/refguide/consistency-errors/) process

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/csharp/extensibility-api-reference-guide/services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ weight: 10
77

88
## Introduction
99

10-
A Studio Pro service is an interface that exposes some core Studio Pro functionality to extensions. These interfaces are named `I*Service` and can be found in `Mendix.StudioPro.ExtensionsAPI.Services` or `Mendix.StudioPro.ExtensionsAPI.UI.Services` namespaces. It can be injected using the Microsoft Extensions Framework, also referred to as MEF. For more information about MEF and how to use it please refer to the official [Microsoft documentation](https://learn.microsoft.com/en-us/dotnet/framework/mef/)
10+
A Studio Pro service is an interface that exposes some core Studio Pro functionality to extensions. These interfaces are named `I*Service` and can be found in `Mendix.StudioPro.ExtensionsAPI.Services` or `Mendix.StudioPro.ExtensionsAPI.UI.Services` namespaces. It can be injected using the Microsoft Extensions Framework, also referred to as MEF. For more information about MEF and how to use it, refer to the official [Microsoft documentation](https://learn.microsoft.com/en-us/dotnet/framework/mef/)
1111

1212
{{% alert color="info" %}}You should not implement these interfaces in your production code, although it is possible to make sense to do so for unit testing purposes.{{% /alert %}}
1313

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/csharp/extensibility-api-reference-guide/web-view.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,19 @@ weight: 12
77

88
## Introduction
99

10-
In all places where the Studio Pro Extensibility API allows you to add custom UI, you can use web technology to implement the UI.
10+
Wherever the Studio Pro Extensibility API allows you to add custom UI, you can implement it using web technologies.
1111

12-
Studio Pro contains a built-in web view that you can leverage to show your web-based UI.
13-
Studio Pro also contains a built-in web server that can be used to serve the web UI, as well as to serve data to the web UI.
12+
Studio Pro includes a built-in web view for displaying your web-based UI. It also provides a built-in web server that can be used to serve both the web UI and the data it requires.
1413

15-
In addition, there is a two-way message passing mechanism for direct communication between the web content and the C# part of your extension.
14+
Additionally, a two-way message passing mechanism enables direct communication between the web content and the C# part of your extension.
1615

1716
## Showing a Web View in the UI
1817

19-
There are a number of places where the Studio Pro Extensibility API allows you to add custom UI.
18+
There are a number of places where the Extensibility API allows you to add custom UI.
2019

21-
Typically, the Extensibility API requires you to return a view model for your UI, and for every view model type, there is a corresponding base class for showing the UI in a web view.
20+
Typically, the Extensibility API requires you to return a view model for your UI. Every view model type has a corresponding base class used to display the UI in a web view.
2221

23-
The following table shows the APIs that allow you to add custom UI, and the corresponding view model base class:
22+
The table below lists the APIs that support custom UI and the corresponding view model base class:
2423

2524
| UI element | API for adding UI | Base class for view model |
2625
|--------------------------------|------------------------------------------|--------------------------------|
@@ -51,7 +50,7 @@ For serving content to the web view and communicating both ways with it, see [Bu
5150

5251
If your pane or tab was open when Studio Pro was closed, your web content might fail to load when you reopen Studio Pro. This is because the `WebServerBaseUrl` property is null due to timing issues in the startup sequence.
5352

54-
To resolve this, listen to `OnWebServerBaseUrlChanged` in your `WebServerExtension`. This will get the URL when it gets re-initialized.
53+
To resolve this, listen to `OnWebServerBaseUrlChanged` in your `WebServerExtension`. This will get the URL when it is reinitialized.
5554

5655
You can use the following code:
5756

0 commit comments

Comments
 (0)