Documentation Center

GUI Editor Extension

An Editor represents a complete GUI extension to Content Manager. This can be anything from a new button in an existing GUI or a completely new user interface built from scratch. The extension point for an Editor is called UIEditor.

Each Editor has the following custom properties, configured in its properties section in the manifest file, manifest.json:
Property nameProperty description
nameThe name of the Editor.
contentFolderThe name of the folder inside the Add-on package (ZIP file) containing the Editor's resources.
configurationPathThe relative path to, and filename of, the configuration file that defines this Editor. This path is relative to the root folder of the ZIP file.
assembliesFolderOptional: the relative path to the folder containing any .NET assemblies (.dll files) needed by the Editor. This path is relative to the root folder of the ZIP file.
globalResourcesFolderOptional: the relative path to the folder containing any string resources (.resx files) needed by the Editor. This path is relative to the root folder of the ZIP file.
Here are the contents of a GUI Editor Extension as configured in the manifest file:
{
  "name":"MyGUIExtensionEditor",
  "type": "UIEditor",
  "properties": {
    "name": "MyGUIExtensionEditor",
    "contentFolder": "MyGUIExtension\\Editor",
    "configurationPath": "MyGUIExtension\\Editor\\Configuration\MyGUIExtensionEditor.config",
    "assembliesFolder": "MyGUIExtension\\Editor\\Assemblies",
    "globalResourcesFolder": "MyGUIExtension\\Editor\\Resources",
  }
}
This configuration assumes that the Add-on package (ZIP file) contains the following folders:
  • MyGUIExtension\Editor\, containing the necessary resources for this Editor
  • MyGUIExtension\Editor\Configuration\, containing a configuration file called MyGUIExtensionEditor.config
  • MyGUIExtension\Editor\Assemblies\, containing one or more .NET assemblies for this Editor
  • MyGUIExtension\Editor\Resources\, containing one or more string resource files for this Editor

The name of the Editor will be MyGUIExtensionEditor.