Merge pull request mendix#10176 from mendix/qt-csharp

Review C# Extension docs

Author: quinntracy

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

@@ -7,15 +7,19 @@ weight: 15
 
 ## Introduction
 
-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-11/create-menu-extension/) first.
+This how-to describes how to add a menu that contains sub-menus, some of which also contain sub-menus of their own. 
 
 You can download the example in this how-to in [this GitHub repository](https://github.com/mendix/ExtensionAPI-Samples).
 
+## Prerequisites
+
+This how-to uses the results of [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/). Complete that how-to before starting this one.
+
 ## Creating Menu Extension Class
 
-1. Open the project that you previously created when you followed [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/).
+1. Open the project you created when following [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/).
 2. Add a new class to the project and name it `MyMenuExtension.cs`.
-3. Replace the code in the file with the following code:
+3. Replace the code in the file with the following:
 
     ```csharp
     using Mendix.StudioPro.ExtensionsAPI.UI.Menu;
@@ -57,10 +61,41 @@ You can download the example in this how-to in [this GitHub repository](https://
     }
     ```
 
-The code above creates a single menu, `Beverages`, which contains the submenus `Hot` and `Cold`, both of which contain some submenus. Note that when you are creating this menu structure, you only return the main parent menu (in this example, the `Beverages` menu) from the `GetMenus` method. You should only return the topmost parents in your list, so only the ones that do not have a parent should be returned. In the example above, there is only one.
+### Menu Structure Overview
+
+The code above creates a single menu, `Beverages`. This menu contains the following:
+
+* `Beverages` contain two sub-menus: `Hot` and `Cold`
+* `Hot` contains `Coffee` and `Tea`
+* `Coffee` contains `Black Coffee`, `Decaf`, and `Espresso` 
+* `Espresso` contains `Regular Espresso` and `Ristretto` 
+* `Cold` contains `Soda`
+
+Only the top-most parent menu (`Beverages`) is returned from the `GetMenus` method. You should only return menus that do not have a parent.
+
+### Menu Placement
+
+If an app contains one or more extensions, a top-level menu named `Extensions` will appear in the main menu bar of Studio Pro. 
+
+Menus that are created from `MenuExtension` implementations are grouped by their extension entry point name (in this example, `MyCompany`), and are placed under a dedicated sub-menu. For example, `MyMenuExtension` will be placed as follows: **Extensions** > **MyCompany** > **MyMenuExtension**.
+
+### Menu Properties
+
+A menu can either:
+
+* Be a parent (a menu that contains sub-menus), or 
+* Have an action
+
+You cannot create a menu that both contains sub-menus and has an action.
+
+#### Separators
+
+You can add a `MenuSeparator` to a menu using the `Separator` property. The options include:
 
-If an app contains one or more extensions, a top-level menu named `Extensions` will appear in the main menu bar of Studio Pro. Menus that are created from `MenuExtension` implementations will be grouped by their extension entry point name (in this example, `MyCompany`), and then placed under their own dedicated submenu under the main `Extensions` top-level menu. For example, the `MyMenuExtension` above will be placed as follows: **Extensions** > **MyCompany** > **MyMenuExtension**.
+* `After`
+* `Before` 
+* `None` (default). 
 
-A menu can only be a parent (namely, a menu that contains submenus) or have an action. You cannot create a menu with an action which also contains submenus.
+#### Enabling and Disabling Menus
 
-You can add a `MenuSeparator` to a menu, via the `Separator` property. Options are `After`, `Before` or `None`. The default value is `None`. You can also disable a menu by setting its `IsEnabled` property to `false`. Menus are enabled by default.
+Menus are enabled by default. To disable a menu, set its `IsEnabled` property to `false`.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/csharp/extensibility-api-howtos/build-todo-example-extension.md

@@ -7,17 +7,19 @@ weight: 6
 
 ## Introduction
 
-It is possible to add a context menu to an `IEntity` in Studio Pro or to a `IDocument`, such as microflows and pages, etc. Context menus will be placed under a menu named after the extension that contains them (e.g. `MyExtension`) and context menus can modify those items they relate to. You can achieve this simple by specifying the type when creating the extension.
-
-This how-to describes how you can add a context menu to an entity. Before you start this how-to, it is recommended to [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/) first.
+You can add a context menu to an `IEntity` in Studio Pro or to a `IDocument`, such as microflows and pages. These context menus will appear under a menu named after the extension that contains them (for example, `MyExtension`) and can modify the items they relate to. This is achieved by specifying the type when creating the extension.
 
 You can download the example in this how-to in [this GitHub repository](https://github.com/mendix/ExtensionAPI-Samples).
 
+## Prerequisites
+
+ Before you start this how-to, it is recommended to [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/) first.
+
 ## Creating an Entity Context Menu Extension Class
 
-1. Open the project that you previously created when you followed [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/).
-2. Add a new class to the project and name it `MyEntityContextMenuExtension.cs`.
-3. Replace the code in the file with the following code:
+1. Open the project you previously created by following [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/).
+2. Add a new class to the project named *MyEntityContextMenuExtension.cs*.
+3. Replace the code in the file with the following:
 
     ```csharp
     namespace MyCompany.MyProject.MendixExtension;
@@ -90,15 +92,20 @@ You can download the example in this how-to in [this GitHub repository](https://
     }
     ```
 
-The code above creates a series of context menu items for any entity. It is important to note the type `IEntity` is passed in so that the context menu will only apply to entities. It adds menus using the same logic as `MenuExtension.cs`. For more examples, see [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/).
+The code above creates a series of context menu items for any entity. The menus allow you to:
 
-In the code above, you can see a few context menus that can perform changes on the entity they belong to. In The entity's location on the canvas can be changed, it can be renamed, and some of its information is shown in a message box. 
+* Rename the entity
+* Change the entity's location on the canvas
+* Display entity information in a message box
+* Enable a previously disabled menu item
 
-It is also possible to add menus that are disabled until some action is performed.
+{{% alert type="info" %}}
+The type `IEntity` is passed so the context menu will only apply to entities. It adds menus using the same logic as `MenuExtension.cs`. For more examples, see [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/).
+{{% /alert %}}
 
 ## Adding a Context Menu to a Document
 
-You can also add a context menu to a document. All you have to do is specify the type `IDocument` in the context menu extension.
+You can also add a context menu to a document. To do this, specify the type `IDocument` in your context menu extension.
 
 ```csharp
 namespace MyCompany.MyProject.MendixExtension;

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

@@ -7,15 +7,19 @@ weight: 5
 
 ## Introduction
 
-This how-to describes how you can add a custom dockable web pane window to Studio Pro. Before you start this how-to, it is recommended to [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/) first.
+This how-to describes how to add a custom dockable web pane window to Studio Pro. 
 
 You can download the example in this how-to in [this GitHub repository](https://github.com/mendix/ExtensionAPI-Samples).
 
+## Prerequisites
+
+Before you start this how-to, it is recommended to [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/) first.
+
 ## Creating a Dockable Pane Extension Class
 
-1. Open the project that you previously created when you followed [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/).
-2. Add a new class to the project and name it `MyDockablePaneExtension.cs`.
-3. Replace the code in the file with the following code:
+1. Open the project you previously created by following [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/).
+2. Add a new class to the project named *MyDockablePaneExtension.cs*.
+3. Replace the code in the file with the following:
 
     ```csharp
     using System.ComponentModel.Composition;
@@ -33,13 +37,13 @@ You can download the example in this how-to in [this GitHub repository](https://
     }
     ```
 
-## The View Model for the Extension Tab
+## Creating The View Model for the Extension Tab
 
-The dockable pane will have content, and this content comes in the form of a view model. The view model is an implementation of `WebViewDockablePaneViewModel`. 
+The dockable pane has content, which is provided through a view model. The view model is an implementation of `WebViewDockablePaneViewModel`. 
 
-You need to override the `InitWebView` method in which you can set up the content of your web view inside the dockable pane. In this example, it will contain the home page of `http://mendix.com`.
+Override the `InitWebView` method, where you can set up the content of your web view inside the dockable pane. In this example, it contains the `http://mendix.com` home page.
 
-Below is a small example code of the view model:
+Below is a code example of the view model:
 
 ```csharp
 using Mendix.StudioPro.ExtensionsAPI.UI.DockablePane;
@@ -57,7 +61,12 @@ public class MyDockablePaneExtensionWebViewModel(string homePage) : WebViewDocka
 {{% snippet file="/static/_includes/apidocs-mxsdk/warning-wwwroot.md" %}}
 {{% /alert %}}
 
-The code above creates a new web-enabled tab view. You still need a way to show the new dockable pane. To do so, you need to modify the menu extension you added when you followed [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/). Simple replace the existing content of `MyMenuExtension.cs` with the following code:
+## Displaying the Pane Through a Menu
+
+To show the new dockable pane, modify the extension you created when following [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/). 
+
+1. Open `MyMenuExtension.cs`.
+2. Replace its contents with the following code:
 
 ```csharp
 using System.ComponentModel.Composition;
@@ -77,17 +86,18 @@ public class MyMenuExtension(IDockingWindowService dockingWindowService, IMessag
 }
 ```
 
-The code above introduces a few new concepts.
+The code above introduces the following concepts:
 
-Firstly, you inject the `IDockingWindowService` so that you can open a new dockable pane.
+* The `IDockingWindowService` is injected to allow opening the dockable pane
+* A new menu item named *Open My Dockable Pane* is added to trigger the pane using the `IDockingWindow` service
 
-Secondly, you add a new menu item with the caption **Open My Dockable Pane** that you will use to open your new dockable pane using the `IDockingWindow` service that you have injected.
+Once you have made these changes, build your project. If you have opted to not automatically copy the output to the destination folder, manually copy the bin output from your project to your extension folder you created when you followed the [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/) process.
 
-In order for the changes to reflect, you need to build your project. If you have opted to not automatically copy the output to the destination folder, then you will also need to manually copy the bin output from your project to your extension folder you created when you followed [Create a Menu Extension Using C#](/apidocs-mxsdk/apidocs/csharp-extensibility-api-11/create-menu-extension/).
+## Showing a Dockable Pane Without a Custom Menu
 
-## Showing a Dockable Pane Without Adding a Custom Menu
+If you prefer to not add a separate menu item to open the docking pane, you can override the `ViewMenuCaption` property in the `DockablePaneExtension` implementation. 
 
-Instead of adding a separate menu to open the docking pane, you can override the `ViewMenuCaption` property in the implementation of the `DockablePaneExtension`. This means that the menu that opens will be placed under the `View` top-level menu in Studio Pro and will have the caption provided. There is no need for a separate `MenuExtension` in this case.
+This places the menu under the `View` top-level menu in Studio Pro using the caption provided. In this case, you do not need a separate `MenuExtension` class.
 
 ```csharp
 public override string? ViewMenuCaption => "My pane without custom menu";