Extensibility API
Introduction
Extensions are self-contained modules which users can add to Studio Pro. This means that with extensibility you can add new features and functionality to Studio Pro. The Extensibility API is an API that allows developers to interact with a curated list of internal systems of Studio Pro. This documentation provides guides and reference documentation for the Extensibility API.
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.
Prerequisites
- You need at least a basic understanding of the Mendix platform.
- You need some understanding of the Mendix Model.
- You need to have some C# development experience. Extensions are developed using C#, and compiled into a
.dll
assembly file.
Getting Started
For detailed explanation on how to get started with extensions, check out Get Started with the Extensibility API.
You can also check out our examples and API reference documentation.
How-tos
Here is a list of how-tos for you to begin with:
- How to create a menu extension
- How to create a dockable pane
- How to add a context menu to an entity
- How to host some web content inside a modal dialog using a modal web view
- How to create microflows for calculations
Advanced APIs
APIs for the Mendix platform’s advanced users:
Learn More
You can dive into the following topics in depth:
- What are the extension points
- What are the Extensibility API services
- How to access the Studio Pro from the Model API
- How to host web content via a web view wrapper
- How to build a Todo example extension
- What are extension points