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
description: "The C# extensibility API allows your custom Studio Pro extensions developed in C# to interact with some internal services of Studio Pro."
6
6
weight: 10
7
-
no_list: false
8
-
description_list: true
9
7
aliases:
10
8
- /apidocs-mxsdk/apidocs/extensibility-api/
11
9
---
@@ -20,21 +18,25 @@ For information on new releases of the Extensibility API, see [Extensibility: C#
20
18
21
19
## Introduction
22
20
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-10/).
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-10/)).
24
22
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.
26
24
27
25
## Prerequisites
28
26
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
+
* Some C# development experience
32
+
33
+
Extensions are developed using [C#](https://docs.microsoft.com/en-us/dotnet/) and compiled into a `.dll` assembly file.
32
34
33
35
## Getting Started
34
36
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-10/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-10/get-started/).
36
38
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).
38
40
39
41
## How-tos
40
42
@@ -48,18 +50,14 @@ Here is a list of how-tos for you to begin with:
48
50
49
51
## Advanced APIs
50
52
51
-
APIs for the Mendix platform's advanced users:
53
+
Below are APIs for advanced users:
52
54
53
55
*[Use the Untyped Model Access API Using C#](/apidocs-mxsdk/apidocs/untyped-model-access-api-10/)
54
56
55
-
## Learn More
56
-
57
-
You can dive into the following topics in depth:
57
+
## Reference Guides
58
58
59
-
*[What are extension points](/apidocs-mxsdk/apidocs/csharp-extensibility-api-10/extension-points/)
60
-
*[What are the Extensibility API services](/apidocs-mxsdk/apidocs/csharp-extensibility-api-10/services/)
61
-
*[How to Interact with the Model API Using C#](/apidocs-mxsdk/apidocs/interact-with-model-api-10/)
62
-
*[How to host web content via a web view wrapper](/apidocs-mxsdk/apidocs/csharp-extensibility-api-10/web-views/)
63
-
*[How to Build a Todo Example Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-10/build-todo-example-extension/)
59
+
Review the following reference guides to explore additional Extensibility API topics:
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/extensibility-api/csharp/extensibility-api-howtos/_index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,4 +9,4 @@ description_list: true
9
9
10
10
## Introduction
11
11
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.
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/extensibility-api/csharp/extensibility-api-howtos/add-menu.md
+43-8Lines changed: 43 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,15 +7,19 @@ weight: 15
7
7
8
8
## Introduction
9
9
10
-
This how-to describes how you can add a menu that contains submenus, some of which also contain submenus of their own. Before you start this how-to, it is recommended to [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-10/create-menu-extension/) first.
10
+
This how-to describes how to add a menu that contains sub-menus, some of which also contain sub-menus of their own.
11
11
12
12
You can download the example in this how-to in [this GitHub repository](https://github.com/mendix/ExtensionAPI-Samples).
13
13
14
+
## Prerequisites
15
+
16
+
This how-to uses the results of [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-10/create-menu-extension/). Complete that how-to before starting this one.
17
+
14
18
## Creating Menu Extension Class
15
19
16
-
1. Open the project that you previously created when you followed[Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-10/create-menu-extension/).
17
-
2. Add a new class to the project and name it `MyMenuExtension.cs`.
18
-
3. Replace the code in the file with the following code:
20
+
1. Open the project you created when following[Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-10/create-menu-extension/).
21
+
2. Add a new class to the project and name it *MyMenuExtension.cs*.
22
+
3. Replace the code in the file with the following:
19
23
20
24
```csharp
21
25
usingMendix.StudioPro.ExtensionsAPI.UI.Menu;
@@ -57,10 +61,41 @@ You can download the example in this how-to in [this GitHub repository](https://
57
61
}
58
62
```
59
63
60
-
Thecodeabovecreatesasinglemenu, `Beverages`, whichcontainsthesubmenus `Hot` and `Cold`, bothofwhichcontainsomesubmenus. Notethatwhenyouarecreatingthismenustructure, youonlyreturnthemainparentmenu (inthisexample, the `Beverages` menu) fromthe `GetMenus` method. Youshouldonlyreturnthetopmostparentsinyourlist, soonlytheonesthatdonothaveaparentshouldbereturned. Intheexampleabove, thereisonlyone.
0 commit comments