Skip to main content

Manifest Structure

The manifest structure is as follows:

File Name

  • manifest.json (One is required directly under the folder for each extension)

Description Format

  • JSON format
note
  • Manifest descriptions are case-sensitive.

Description Content

Details are explained on the following pages.

manifest.json
{
//Extension Definition
"name": "HelloWorld",
"main": "main.cs", //For C# scripts. In Python, this is "main.py"
"lifecycle": "application",

/Extension Point Definition
"extensionPoints": {
/Ribbon
"ribbon": {
"tabs": [
/Ribbon Tabs
{
"id": "HelloWorld.MainTab",
"label": "Hello World",
"groups": [
/Groups within Ribbon Tabs
{
"id": "HelloWorld.FirstGroup",
"label": "Group 1",
"controls": [
/Buttons
{
"id": "HelloWorld.SayHelloButton",
"type": "Button",
"label": "Say Hello",
"imageLarge": "images/About.png",
"command": "Command.SayHello"
}
]
}
]
}
]
},
/Commands
"commands": [
{
"id": "Command.SayHello",
"execFunc": "SayHello"
}
]
}
}
For Python scripts

When developing extensions with Python scripts, specify a .py file in main. Specify the Python function name in execFunc for commands and events. The rest of the manifest structure is the same as for C# scripts.